Arcentry
Javascript wrapper for Arcentry API.
Installation
$ npm install --save arcentry
Sample Usage
const Arcentry = ; const arcentry = apiKey: 'your-api-key'; // Get a list of all documents (https://arcentry.com/api-docs/#list-all-documents)arcentrydocument ; // Get a document by id (https://arcentry.com/api-docs/#get-details-for-a-documentarcentrydocument ; // Get a list of all objects in a document (https://arcentry.com/api-docs/#list-all-objects-for-a-document)arcentryobject ; // Get an object by id (https://arcentry.com/api-docs/#get-properties-for-an-object)arcentryobject ; // Create an object (https://arcentry.com/api-docs/#create-a-new-object)arcentryobject ; // Update an object (https://arcentry.com/api-docs/#set-properties-for-an-object)arcentryobject ; // Delete an object (https://arcentry.com/api-docs/#delete-an-object)arcentryobject ; // Query objects by selector (https://arcentry.com/api-docs/meta-data/#how-to-search-for-metadata)arcentryobject ;
API
This module exports a constructor function which takes an options object.
Arcentry(options)
Creates a new Arcentry
instance.
Arguments
options
- Required - A plain JavaScript object that contains the configuration options.
Options
apiKey
- Required - A string that specifies the Arcentry app's API key.
Return value
An Arcentry
instance.
Exceptions
Throws an Error
exception if the required options are missing.
Example
const Arcentry = ; const arcentry = apiKey: 'your-api-key';
arcentry.document
TBD
arcentry.object
TBD
Running Project Locally
Installing Dependencies
Run yarn install
or npm install
to get the project's dependencies.
Making a Production Build
Run yarn build
or npm run build
to produce minified version of library.
Making a Development Build
Run yarn dev
or npm run dev
to generate an non-minified version of library and watch for file changes.
Running Tests
Run yarn test
or npm run test
.