handwriting-node

0.1.2 • Public • Published

Handwriting.io node.js bindings

Installation

npm install handwriting-node

Documentation

Documentation will come soon.

API Overview

Every resource is accessed via your handwriting instance:

var handwriting = require('handwriting-node')(' your handwriting.io key ', ' your handwriting.io secret ');
// handwriting.{ RESOURCE_NAME }.{ METHOD_NAME }

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

handwriting.handwritings.list()
.then(function(handwritings){
  var thisHandwriting = handwritings[0];
  return handwriting.render.createPdf({
    handwriting_id: thisHandwriting.id,
    text: 'This is a message.\nThis is the next line.'
  });
}).then(function(renderedPdf) {
  renderedPdf; // the pdf object
}).catch(function(err){
  err; // err object with reason and status code
});

Available resources & methods

Where you see params it is a plain JavaScript object, e.g. { email: 'foo@example.com' }

Development

To run the tests you'll need a Handwriting.io Test API key (from your Handwriting.io Dashboard):

$ npm install -g mocha
$ npm test

Thanks

This repository is almost a wholesale clone of Stripe's Node library. A huge thanks goes to their awesome tech team for creating a great model Node library.

Package Sidebar

Install

npm i handwriting-node

Weekly Downloads

4

Version

0.1.2

License

MIT

Last publish

Collaborators

  • cshenoy