@rudderstack/analytics-js

RudderStack JavaScript SDK for browsers.

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

Table of Contents

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

Installing the package

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

npm install @rudderstack/analytics-js --save

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

Available exports

Default export will fetch the plugins during runtime as federated modules in separate requests.

import { RudderAnalytics } from '@rudderstack/analytics-js';

const analytics = new RudderAnalytics();
analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);

Bundled export will contain the plugins code as part of the bundle in build time.

import { RudderAnalytics } from '@rudderstack/analytics-js/bundled';

const analytics = new RudderAnalytics();
analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);

Legacy export will contain the plugins code as part of the bundle in build time and supports legacy browsers like IE11.

import { RudderAnalytics } from '@rudderstack/analytics-js/legacy';

const analytics = new RudderAnalytics();
analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);

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:browser:modern: This outputs dist/cdn/modern folder that contains the CDN package contents.
• npm run build:npm: This outputs dist/npm folder that contains the NPM package contents.

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 more details, see 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 more details, see:

• Vercel Edge Usage
• Cloudflare Worker Usage

License

This project is licensed under the Elastic License 2.0. See the LICENSE.md file for details. Review the license terms to understand your permissions and restrictions.

If you have any questions about licensing, please contact us or refer to the official Elastic licensing page.

Contribute

We invite you to contribute to this project. For more information on how to contribute, please see here.

Contact us

For more information on any of the sections covered in this readme, you can contact us or start a conversation on our Slack channel.

Follow Us

• RudderStack Blog
• Slack
• Twitter
• LinkedIn
• dev.to
• Medium
• YouTube
• HackerNews
• Product Hunt

:clap: Our Supporters