npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

syncano

v1.0.30

Published

A library to intereact with the Syncano API.

Downloads

166

Readme

Syncano Javascript Library

npm version Circle CI

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.

Also check out our libraries for iOS, Python, Ruby, Android and Arduino. We also have an AngularJs integration available.

Getting started

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.

Installing from Bower

bower install syncano --save

Client-side usage

<script src="path/to/bower_components/syncano/dist/syncano.min.js"></script>

Installing from NPM

npm install syncano --save

Server-side usage

The library supports the CommonJS syntax:

var Syncano = require('syncano');

You can also use it with ES6 modules:

import Syncano from 'syncano';

Creating a connection

To create a connection, simply initialize the Syncano object with the following configuration parameters:

// create a connection with an account key
var connection = Syncano({ accountKey: 'MY_ACCOUNT_KEY'});

// create a connection with a user key
var connection = Syncano({ userKey: 'USER_KEY'});

// create a connection with a social token
var connection = Syncano({ socialToken: 'SOCIAL_TOKEN'});

// create a connection with a api key
var 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:

connection.Instance({name: 'silent-dawn-3609'}).classes().list()

QuerySet

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:

connection.Instance.please().list()
  .then(function(result) {
    // handle result
  })
  .catch(function(error) {
    // handle error
  });

Contributing

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.

Contributors