Skip to content

Latest commit

 

History

History
86 lines (74 loc) · 3.69 KB

README.md

File metadata and controls

86 lines (74 loc) · 3.69 KB

Onfleet node.js bindings

Installation

npm install onfleet

API Overview

Every resource is accessed via your onfleet instance:

var onfleet = require('onfleet')('YOUR_ONFLEET_API_KEY');

Every resource method accepts an optional callback as the last argument:

onfleet.tasks.create(
  { ... },
  function(error, task) {
    error; // null if no error occurred
    task; // the created task object
  }
);

Additionally, every resource method returns a promise, so you don't have to use the regular callback. E.g.

// Create a new task :
onfleet.tasks.create(
  { ... }
).then(function(task) {
  // New task created
}).catch(function(err) {
  // Deal with an error
});

Available resources & methods

Where you see params it is a plain JavaScript object, e.g. { email: '[email protected]' }