@rudderstack/analytics-js-service-worker

The Customer Data Platform for Developers

Website · Documentation · Community Slack

@rudderstack/analytics-js-service-worker

RudderStack Javascript SDK service worker that can be used in browser extensions and serverless runtimes. It exposes the same interface and features as the NodeJS SDK

For detailed documentation on the RudderStack JavaScript SDK, click here.

Table of Contents

• Installing the package
• Usage in Chrome Extensions
• Usage in Serverless Runtimes
• How to build the SDK

Installing the package

To install the package via npm, run the following command:

npm install @rudderstack/analytics-js-service-worker --save

import { Analytics } from '@rudderstack/analytics-js-service-worker';

const rudderClient = new Analytics('<writeKey>', '<dataplaneUrl>/v1/batch');

Note that this NPM module is only meant to be used for a service worker usage. If you want to integrate RudderStack with your Node.js application, refer to the RudderStack Node.js repository.

Usage in Chrome Extensions

RudderStack JS SDK can be used in Chrome Extensions with manifest v3, both as a content script (via the JavaScript SDK package) or as a background script service worker (via the service worker package).

For examples and specific details look into Chrome Extensions Usage

Usage in Serverless runtimes

RudderStack JS SDK service worker can be used in serverless runtimes like Cloudflare Workers or Vercel Edge functions.

For examples and specific details look into:

• Vercel Edge Usage
• Cloudflare Worker Usage

How to build the SDK

• Look for run scripts in the package.json file for getting the browser minified and non-minified builds. The builds are updated in the dist folder of the directory. Among the others, some of the important ones are:

  • npm run build:package: This outputs dist/npm folder that contains the npm package contents.