usertrails-nodejs

Usertrails@1.0.0

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install usertrails@1.0.0 --save

const usertrails = require('usertrails');

const configuration = new usertrails.Configuration({
    baseOptions: {
        headers: {
            'key': "product-key-from-dashboard"
        }
    }
});

const client = new usertrails.UsertrailsApi(configuration);

client.profile()...
client.record()...

unPublished (development):

npm install PATH_TO_GENERATED_PACKAGE --save