LayerVault JS Client
NodeJS client for accessing the LayerVault API.
Installation
The library is available on npm:
npm install layervault
Configuration
var LayerVault = ;// Configurevar config = {thisoauthKey = 'abc123'thisoauthSecret = 'foobar'// optional, if you have itthisaccessToken = 'sloths567'thisrefreshToken = 'blahblah'};// Create the clientvar client = config;
Usage
Authentication
// If configured without an access token, you will need// to authenticate and retrieve one. Here's the password flow:clientauth;
Because LayerVault uses OAuth refresh tokens, we need to watch out for their expiration and retrieve new tokens when they do. This is automatically handled internally in the library, and the new tokens are exposed via an event. This event is fired whenever authorization completes, so you can use it instead of providing a callback to withPassword
like above.
clientauth;
Retrieving Data
This API client uses a lightweight resource model to make getting associations very easy.
// We can retrieve information about the logged in user.client;
You can chain together objects to build a query. Responses are parsed to include proper object associations so you can continue to drill down data.
Arguments to the data types can be given as separate arguments (shown below), as path style ("Test/Stuff"), or a combination of both.
client;
Uploading a File/Revision
Creating a new file and uploading a new revision are the same process. While it is a multi-step process, the API client takes care of most of the steps for you.
To upload a file, all you need to provide is the path to the file on disk and the mime-type of the file.
client;
Promises
All asynchronous calls return a promise, which can be used as an alternative to providing a callback.
clientauth;
TODO
- Allow file uploads to accept a file buffer
- Implement authorization code OAuth flow
Links
Author
Ryan LeFevre - GitHub, Twitter, Email
License
Available under the MIT license. See the LICENSE file for more info.