Event Tracking Browser
A project for tracking ptoject.
Usage
yarn add event-tracking-browser
or
npm install event-tracking-browserFeatures
- RollupJS for multiple optimized bundles following the standard convention and Tree-shaking
- Tests, coverage and interactive watch mode using Jest
- Prettier and TSLint for code formatting and consistency
- Docs automatic generation and deployment to
gh-pages, using TypeDoc - Automatic types
(*.d.ts)file generation - Travis integration and Coveralls report
- (Optional) Automatic releases and changelog, using Semantic release, Commitizen, Conventional changelog and Husky (for the git hooks)
NPM scripts
npm t: Run test suitenpm start: Runnpm run buildin watch modenpm run test:watch: Run test suite in interactive watch modenpm run test:prod: Run linting and generate coveragenpm run build: Generate bundles and typings, create docsnpm run lint: Lints codenpm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)
Index
Interfaces
Functions
Functions
Const identify
-
Parameters
-
Optional uniqueId: undefined | string
A string that uniquely identifies a user. If not provided, the distinctId currently in the persistent store (cookie or localStorage) will be used.
Returns undefined | string
-
Const init
-
This function initializes a new instance of the tracking object
Parameters
-
token: string
API token.
-
Optional config: EventTrackerOptions
A dictionary of config options to override default config.
Returns string
distinctId.
-
Const register
-
Register a set of super properties, which are included with all events.
Parameters
-
properties: any
An associative array of properties to store about the user
Returns any
-
Const track
-
Track an event
Parameters
-
eventName: string
The name of the event. This can be anything the user does - 'Button Click', 'Sign Up', etc.
-
properties: any
A set of properties to include with the event you're sending
Returns { eventName: string; properties: any }
If the tracking request was successfully initiated/queued, an object with the tracking payload sent to the API server is returned; otherwise false.
-
event
Name: string -
properties: any
-
Generated using TypeDoc
Identify a user with a unique ID to track user activity across devices, tie a user to their events, and create a user profile. If you never call this method, unique visitors are tracked using a UUID generated the first time they visit the site.