This library enables you to interact with the Syncano platform via Javascript. For more information on the platform, please refer to the docs and the FAQ.
In order to use the plaftorm, you need an account - you can sign up here.
The library can be used server-side and client-side. You can install the library using npm, bower or by downloading a release from the Github repository.
To create a connection, simply initialize the Syncano object with the following configuration parameters:
// create a connection with an account keyvar connection = Syncano({ accountKey: 'MY_ACCOUNT_KEY'});// create a connection with a user keyvar connection = Syncano({ userKey: 'USER_KEY'});// create a connection with a social tokenvar connection = Syncano({ socialToken: 'SOCIAL_TOKEN'});// create a connection with a api keyvar connection = Syncano({ apiKey: 'API_KEY'});
From now on, you can access all of the objects on the platform via the connection object.
Basic interactions
Model instances
The connection you configured in the previous step has a set of factories that make interacting with objects on the platform easier. For example, if you would like to create a new instance object, you can do it like so:
var instance = connection.Instance({ name: 'INSTANCE_NAME', description: 'INSTANCE_DESCRIPTION' });
You can later save the instance, by calling its save method:
instance.save();
Nested models
The objects (models) are also nested, so if you would like to list the Classes of an Instance, there's an elegant function chain for that:
Every model has a static please method that returns a QuerySet object allowing you to perform additional queries like like listing objects:
connection.Instance.please().list();
Promises
The library uses Promises to enforce writing more readable and elegant code. You can get the result of a query with the then metod and the errors with the catch method:
This library is built using Stampit. If you find a bug, feel free to submit an issue. If you would like to directly contribute to the library, we are open for pull requests.