backloggery

1.0.1 • Public • Published

Backloggery

A javascript (node + browser) module for pulling game data from Backloggery.

Usage

To use the API within your code you can use #request to return all the games that have been attached to a user's account.

import { Backlogger } from 'backloggery';

Backloggery.request('{{username}}', (err, games) => {
  console.log(`{{username}} has ${games.length} games`);
})

Each Game may contain:

{
  "title": "The name of the game, as added by the user",
  "system": "Console (Original Console)",
  "originalSystem": "The original system the game was released",
  "isCompleted": true|false,
  "rating": 1-5
}

CLI

A CLI is also available for quickly searching users data to use in your shell.

# return all games belonging to {{username}} in JSON format 
npm run cli {{username}} -- --format json

Also supports pipes (with --stdin) if you want to pass Backloggery HTML in directly.

cat test.html | babel-node src/bin/cli.js --stdin

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i backloggery

Weekly Downloads

0

Version

1.0.1

License

MIT

Last publish

Collaborators

  • jimmyhillis