Nomenclature Processing Machine

npm

Join us for the upcoming webinar, "Enterprise JavaScript done right: the tools you love, the security you need."Sign up here »

resin-pine

8.1.0 • Public • Published

resin-pine

npm version dependencies Circle Build Status Appveyor Build status

Join our online chat at Gitter chat

Resin.io PineJS client.

Role

The intention of this module is to provide a ready to use subclass of pinejs-client-js which uses resin-request.

THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.

Unless you know what you're doing, use the Resin SDK instead.

Installation

Install resin-pine by running:

$ npm install --save resin-pine

Documentation

Instantiate the PineJS like that:

var pine = require('resin-pine')({
  apiUrl: "https://api.resin.io/",
  apiVersion: "v2",
  request: request, // An instantiated resin-request instance
  auth: auth // An instantiated resin-auth instance
})

Where the factory method accepts the following options:

  • apiUrl, string, required, is the Resin.io API url like https://api.resin.io/,
  • apiVersion, string, required, is the version of the API to talk to, like v2. The current stable version is v2,
  • apiKey, string, optional, is the API key to make the requests with,
  • request, object, an instantiated resin-request instance.
  • auth, object, an instantiated resin-auth instance.

Head over to pinejs-client-js for the returned PineJS instance documentation.

Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

$ npm test

Contribute

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ npm run lint

License

The project is licensed under the Apache 2.0 license.

install

npm i resin-pine

Downloadsweekly downloads

207

version

8.1.0

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability