linodeius
v0.3.0
Published
Linode API Client
Downloads
10
Readme
Linodeius
This is a promise-based Node.js client for the Linode API version 3.3.
Installation
Install the NPM package and any dependencies automatically with:
npm install linodeius --save
For use in an application:
const Linode = require('linodeius');
const api = new Linode(api_key);
api.linode.list().then(linodes => {
// ...
});
Or for Node.js 8+ with support for async/await:
const Linode = require('linodeius');
const api = new Linode(api_key);
let linodes = await api.linode.list();
// ...
Configuration
The API key can be specified in a number of locations:
- The
api_key
argument tonew Linode()
. - The
LINODE_API_KEY
environment variable which specifies the key. - The
LINODE_API_KEY_FILE
environment variable which specifies a path to a file containing the key. - A
.linode-key
file in the same directory as this package. - A
.linode-key
file in the user's home directory.
The key used to make an API call is dependent on those factors evaluated in that order of priority.
TODO
- Add support for batch operations via the
api_action=batch
mode.
License and Copyright
Copyright (C) 2016-2017 Scott Tadman [email protected], PostageApp.
Licensed under the MIT License. See the LICENSE file for details.