Segmentio-commonjs-client NPM

segmentio-commonjs-client

A npm-based client for SegmentIO that is expected to be used client-side via CommonJS. For server-side, look to analytics-node which supports buffering. This project exists because while analytics-node can be used client-side, doing so has some downsides:

results in big payload because need NodeJS buffer implementation for browsers
leaks lodash to window._ (reported as an issue so may change)

Basic overview

To create an instance of the client pass the SegmentIO write key:

var Analytics = require('segmentio-commonjs-client');

var client = new Analytics('my_segment_write_key');

identify

SegmentIO identify event:

client.identify({
  userId: 'abc123',
  traits: {
    email: 'bob@example.com',
    age: 42
  }
});

track

SegmentIO track event:

client.track({
  userId: 'abc123',
  event: 'MyEvent',
  properties: {
    arbitraryKey: 'someValue'
  }
});

setLoggingOnly

The client has a setLoggingOnly() function that can be called to disable actually interacting with the SegmentIO API -- instead the calls are logged to the console. This is useful when in non-production model.