hapi-km
Hapi plugin wrapping kilometer.io's REST api for easy access within the server. On successful registration, four new methods will be available on the server.methods object.
Installation:
npm install --save hapi-km
Example usage:
'use strict'; const Hapi = ; // Create a server with a host and portconst server = ;server; server; // An example route using the pluginserver; // Start the serverserverstart { if err throw err; console;};
Methods
trackIdentifiedEvent(options, [callback])
Tracks an identified event at kilometer.io.
options
An object with the following keys:user_id
A kilometer.io user idevent_name
The name of the event_nameevent_properties
An object with one or more propertiesevent_property
A property on the event_propertyevent_property_2
Yet a property (opt.)
callback
A optional function with signaturefunction(err, res)
with status of the call to kilometer.io.
setUserProperty(options, [callback])
Sets one or more user properties.
options
An object with one or more properties and their values:foo_property
bar_property
callback
A optional function with signaturefunction(err, res)
with status of the call to kilometer.io.
increaseUserProperty(options, [callback])
Increases the value of a property.
options
An object with one property and a numerical value to increase it with:foo_property
callback
A optional function with signaturefunction(err, res)
with status of the call to kilometer.io.
decreaseUserProperty(options, [callback])
Decreases the value of a property.
options
An object with one property and a numerical value to decrease it with:foo_property
callback
A optional function with signaturefunction(err, res)
with status of the call to kilometer.io.