Client library for the libraries.io api.
npm install librarian-api> Client library for the libraries.io api.
$ npm install --save librarian-api
New since version 0.2.0
$3
Paging is now supported with the page` and `per_page` query parameters.
You can also obtain the raw request response passing the `raw: true` option.Please refer to test.js for usage examples.
$3
All queries are now limited to 10 per 10 seconds.New since version 0.1.0
The cli now uses [update-notifier][] to let the user know about updates to this program.Users have the ability to opt-out of the update notifier by changing
the optOut property to true in ~/.config/configstore/update-notifier-rollodeqc-gh-user-streak.json.
The path is available in notifier.config.path.
Users can also opt-out by setting the environment variable NO_UPDATE_NOTIFIER
with any value or by using the --no-update-notifier flag on a per run basis.
Usage
`js
const librarianApi = require('librarian-api');librarianApi('unicorns');
//=> 'unicorns & rainbows'
`Environment variables
You'll need a token from to call the API.Define it as an environment variable:
sh
export LIBRARIES_IO_TOKEN=abcd1234...
`If you use another instance of libraries.io, you can define it the
same way:
sh
export LIBRARIES_IO_ENDPOINT=http://example.com/api
`Otherwise https://libraries.io/api is used.
API
API Docs: https://libraries.io/api$3
#### query
Type: Lorem ipsum.
$3
#### platform
Type: #### name
Type:
Lorem ipsum.
$3
#### platform
Type: #### name
Type:
#### version
Type:
Lorem ipsum.
$3
#### platform
Type: #### name
Type:
Lorem ipsum.
$3
#### platform
Type: #### name
Type:
Lorem ipsum.
$3
#### owner
Type: #### name
Type:
Lorem ipsum.
$3
#### owner
Type: #### name
Type:
Lorem ipsum.
$3
#### owner
Type: #### name
Type:
Lorem ipsum.
CLI
$ npm install --global librarian-api
$ librarian-api --help Usage
librarian-api [input]
Options
--foo Lorem ipsum. [Default: false]
Examples
$ librarian-api
unicorns & rainbows
$ librarian-api ponies
ponies & rainbows
[update-notifier]: