initial-state
v0.2.0
Published
Initial State SDK
Downloads
14
Readme
Initial State
The Initial State SDK for NodeJS.
Installation
npm install initial-state
Example Use
var IS = require('initial-state');
var bucket = IS.bucket('NodeJS SDK Example', 'YOUR_ACCESS_KEY_GOES_HERE');
// Push event to initial state
bucket.push('Demo State', 'active');
setTimeout(function () {
// Push another event
bucket.push('Demo State', 'inactive');
}, 1000);
API
IS.bucket(id, accessKey)
Create an event data bucket.
- id – A bucket key. This key cannot contain the colon (:) character.
- accessKey – An Initial State account access key. This argument is not needed if the access key is assigned to the environmental variable
IS_API_ACCESS_KEY
.
bucket.push(key, value[, date])
Send event data to Initial State.
- key – The event key.
- value – The event value.
- date – The time of the event. A
Date
object or numeric timestamp (milliseconds since epoch). High-precision timestamps (i.e., sub-ms) can be declared as a string (e.g.,'1420070400.000000001'
), but must be in unix time (seconds since epoch). If not defined, a high-precision timestamp will be generated.