@mailbiz/browser-tracker-core
v0.1.12
Published
Core functionality for Mailbiz Browser trackers
Downloads
94
Readme
Mailbiz Browser Tracker Core
Browser Core module to be used by Mailbiz Browser based trackers.
It should rarely be used alone, you probably want @mailbiz/browser-tracker
.
Maintainer quick start
Part of the Mailbiz JavaScript Tracker monorepo.
Build with Node.js (12 LTS or 14 LTS) and Rush.
Setup repository
npm install -g @microsoft/rush
git clone https://github.com/Mailbiz/Mailbiz.Tracker.Javascript.git
rush update
Building Browser Tracker Core
cd libraries/browser-tracker-core
rushx build
Running tests
rushx test
Package Installation
With npm:
npm install @mailbiz/browser-tracker-core
Usage
import { addTracker, createSharedState, getTracker } from '@mailbiz/browser-tracker-core';
const sharedState = createSharedState();
const tracker = addTracker('snowplow_sp1', 'sp1', 'js-3.0.0', '{{collector}}', sharedState, {}); // Also stores reference at module level
const sameTracker = getTracker('snowplow_sp1');
Example
const domainUserId = tracker.getDomainUserId();
Other features
This package contains a number of helper functions for tracking events in the browser as well as the core functionality of the Mailbiz JavaScript Tracker.
Copyright and license
Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).
Copyright (c) 2022 Mailbiz.
All rights reserved.