npmpackage.info

Gathering detailed insights and metrics for rudder-sdk-js

Other packages similar to rudder-sdk-js

@rudderstack/analytics-js

3.17.0

RudderStack JavaScript SDK

rudder-sdk-js-develop

1.0.24

Rudder Javascript SDK

@rudderstack/analytics-js-cookies

0.4.24

RudderStack JavaScript SDK Cookies Utilities

@rudderstack/analytics-js-service-worker

3.2.24

RudderStack JavaScript Service Worker SDK

Gathering detailed insights and metrics for rudder-sdk-js

rudder-sdk-js - 2.51.1 | npmpackage.info

rudder-sdk-js

JavaScript SDK for RudderStack - the Customer Data Platform for Developers.

2.51.1

154

NOASSERTION

TypeScript

37.82 kB

12,290,114 6.8

Installations

npm install rudder-sdk-js

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Node Version

20.11.1

NPM Version

10.2.4 Pull Requests

Open

7

Total

2,101

Closed

313

Merged

1,781

Issues

Open

0

Total

93

Closed

93

Releases

679

rudderstack/analytics-js-service-worker@3.2.24

@rudderstack/analytics-js-service-worker@3.2.24

Updated on Apr 28, 2025

@rudderstack/analytics-js-integrations@3.13.2

Updated on Apr 28, 2025

rudder-sdk-js@2.51.1

Updated on Apr 28, 2025

@rudderstack/analytics-js@3.17.0

Updated on Apr 28, 2025

@rudderstack/analytics-js-plugins@3.8.1

Updated on Apr 28, 2025

@rudderstack/analytics-js-cookies@0.4.24

Updated on Apr 28, 2025

View All 679 releases

Languages

TypeScript

JavaScript

HTML

Shell

TypeScript (49.31%)

JavaScript (43.76%)

HTML (6.5%)

Shell (0.43%)

Developer

rudderlabs

Download Statistics

Total Downloads

12,290,114

Last Day

24,670

Last Week

120,628

Last Month

574,785

Last Year

4,680,312

GitHub Statistics

NOASSERTION License

154 Stars

4,338 Commits

90 Forks

11 Watchers

21 Branches

97 Contributors

Updated on May 09, 2025

Bundle Size

130.13 kB

Minified

37.82 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 97 Contributors

Package Meta Information

Latest Version

2.51.1

Package Id

rudder-sdk-js@2.51.1

Unpacked Size

1.18 MB

Size

332.27 kB

File Count

NPM Version

10.2.4

Node Version

20.11.1

Published on

Apr 28, 2025

Total Downloads

Cumulative downloads

Total Downloads

12,290,114

Last Day

38.4%

24,670

Compared to previous day

Last Week

18.8%

120,628

Compared to previous week

Last Month

-2.9%

574,785

Compared to previous month

Last Year

16.5%

4,680,312

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

The Customer Data Platform for Developers

Website · Documentation · Community Slack

:warning: This package is deprecated and no longer maintained. While your events are still being tracked and delivered, we strongly recommend you to migrate to the latest @rudderstack/analytics-js package for enhanced features, security updates, and ongoing support. For more details, visit the migration guide.

RudderStack JavaScript SDK

The JavaScript SDK lets you track customer event data from your website and send it to your specified destinations via RudderStack.

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

Installing the JavaScript SDK
Identifying your users
Tracking user actions
The ready API
Self-hosted control plane
Adding your own integrations
Usage in Chrome Extensions
Usage in Serverless Runtimes

IMPORTANT: We have deprecated the service worker export from RudderStack JavaScript SDK NPM package and moved it to a separate package. If you still wish to use it for your project, refer to @rudderstack/analytics-js-service-worker package.

Installing the JavaScript SDK

To integrate the JavaScript SDK with your website, place the following code snippet in the <head> section of your website.

1<script type="text/javascript">
2!function(){var e=window.rudderanalytics=window.rudderanalytics||[];e.methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],e.factory=function(t){return function(){e.push([t].concat(Array.prototype.slice.call(arguments)))}};for(var t=0;t<e.methods.length;t++){var r=e.methods[t];e[r]=e.factory(r)}e.loadJS=function(e,t){var r=document.createElement("script");r.type="text/javascript",r.async=!0,r.src="https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";var a=document.getElementsByTagName("script")[0];a.parentNode.insertBefore(r,a)},e.loadJS(),
3e.load(<WRITE_KEY>,<DATA_PLANE_URL>),
4e.page()}();
5</script>

The above snippet lets you integrate the SDK with your website and load it asynchronously to keep your page load time unaffected.

To load rudder-analytics.js on to your page synchronously, you can refer to the minified or non-minified versions of the code in the following sections:

Minified code

1<script>
2  rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}rudderanalytics.load(<WRITE_KEY>,<DATA_PLANE_URL>),rudderanalytics.page();
3</script>
4
5<script src="https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js"></script>

Non-minified code

1<script>
2  rudderanalytics = window.rudderanalytics = [];
3
4  var methods = [
5    'load',
6    'page',
7    'track',
8    'identify',
9    'alias',
10    'group',
11    'ready',
12    'reset',
13    'getAnonymousId',
14    'setAnonymousId',
15  ];
16
17  for (var i = 0; i < methods.length; i++) {
18    var method = methods[i];
19    rudderanalytics[method] = (function (methodName) {
20      return function () {
21        rudderanalytics.push([methodName].concat(Array.prototype.slice.call(arguments)));
22      };
23    })(method);
24  }
25  rudderanalytics.load(YOUR_WRITE_KEY, DATA_PLANE_URL);
26  //For example,
27  //rudderanalytics.load("1Qb1F3jSWv0eKFBPZcrM7ypgjVo", "http://localhost:8080");
28  rudderanalytics.page();
29</script>
30
31<script src="https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js"></script>

In all the above versions, there is an explicit page call at the end. This is added to ensure that whenever the SDK loads in a page, a page call is sent. You can remove this call completely or modify it with the extra page properties to suit your requirement. You can also add page calls in your application in places not tied directly to page load, e.g., virtual page views, page renders on route change such as in SPAs, etc.

Write key and data plane URL

To integrate and initialize the JavaScript SDK, you will need the source write key and the data plane URL.

To get the source write key, follow this guide.
To get the data plane URL, follow this guide.

Alternative installation using NPM

Although we recommend using the snippets mentioned above to use the JavaScript SDK with your website, you can also use this NPM module to package RudderStack directly into your project.

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

1npm install rudder-sdk-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.

IMPORTANT: Since the module exports the related APIs on an already-defined object combined with the Node.js module caching, you should run the following code snippet only once and use the exported object throughout your project:

1import * as rudderanalytics from "rudder-sdk-js";
2rudderanalytics.ready(() => {
3  console.log("we are all set!!!");
4});
5rudderanalytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);
6export { rudderanalytics };

You can also do this with ES5 using the require method, as shown:

1var rudderanalytics = require("rudder-sdk-js");
2rudderanalytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);
3exports.rudderanalytics = rudderanalytics;

For destinations where you don't want the SDK to load the third-party scripts separately, modify the load call as shown:

1rudderanalytics.load(<YOUR_WRITE_KEY>, <DATA_PLANE_URL>, {loadIntegration:  false})

For more information on the load() method, refer to the detailed JavaScript SDK documentation.

A few important things to note:

The SDK expects the destination global queue or function for pushing the events is already present for the particular destination/s.
Currently, loadIntegration is supported only for Amplitude and Google Analytics.
The JavaScript SDK expects window.amplitude and window.ga to be already defined by the user separately for the sending the events to these destinations.

Exported APIs

The APIs exported by the module are:

load
ready
identify
alias
page
track
group
reset
getAnonymousId
setAnonymousId

Sample implementations

Refer to the following projects for a detailed walk-through of the above steps:

Supported browser versions

Browser	Supported Versions
Safari	v7 or later
IE	v11 or later
Edge	v80 or later
Mozilla Firefox	v47 or later
Chrome	v54 or later
Opera	v43 or later
Yandex	v19.10 or later

If the SDK does not work on the browser versions that you are targeting, verify if adding the browser polyfills to your application solves the issue.

Identifying users

The identify call lets you identify a visiting user and associate them to their actions. It also lets you record the traits about them like their name, email address, etc.

A sample identify() call is shown below:

1rudderanalytics.identify(
2  '12345',
3  {
4    email: 'name@domain.com',
5  },
6  {
7    page: {
8      path: '',
9      referrer: '',
10      search: '',
11      title: '',
12      url: '',
13    },
14  },
15  () => {
16    console.log('in identify call');
17  },
18);

In the above example, the user-related information like the userId and email along with the contextual information is captured.

There is no need to call identify() for anonymous visitors to your website. Such visitors are automatically assigned an anonymousId.

For more information on how to use the identify call, refer to the JavaScript SDK documentation.

Tracking user actions

The track call lets you record the customer events, i.e. the actions that they perform, along with any associated properties.

A sample track call is shown below:

1rudderanalytics.track(
2  'test track event GA3',
3  {
4    revenue: 30,
5    currency: 'USD',
6    user_actual_id: 12345,
7  },
8  () => {
9    console.log('in track call');
10  },
11);

In the above example, the track method tracks the user event ‘test track event GA3’ and information such as the revenue, currency, anonymousId.

You can use the track method to track various success metrics for your website like user signups, item purchases, article bookmarks, and more.

The `ready` API

There are cases when you may want to tap into the features provided by the end-destination SDKs to enhance tracking and other functionalities. The JavaScript SDK exposes a ready API with a callback parameter that fires when the SDK is done initializing itself and the other third-party native SDK destinations.

An example is shown in the following snippet:

1rudderanalytics.ready(() => {
2  console.log('we are all set!!!');
3});

For more information on the other supported methods, refer to the JavaScript SDK APIs.

Self-Hosted control plane

If you are using a device mode destination like Heap, FullStory, etc., the JavaScript SDK needs to fetch the required configuration from the control plane.

If you are self-hosting the control plane using the RudderStack Control Plane Lite utility, your load call will look like the following:

1rudderanalytics.load(<WRITE_KEY>, <DATA_PLANE_URL>, {
2  configUrl: <CONTROL_PLANE_URL>,
3});

More information on how to get the CONTROL_PLANE_URL can be found here.

For detailed technical documentation and troubleshooting guide on the RudderStack’s JavaScript SDK, check out our docs.

Adding your own integrations

You can start adding integrations of your choice for sending the data through their respective web (JavaScript) SDKs.

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: This outputs dist/cdn/legacy/rudder-analytics.min.js.
- npm run build:package: This outputs dist/npm folder that contains the npm package contents.

We use rollup to build our SDKs. The configuration for it is present in rollup-configs folder.

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:

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.

:clap: Our Supporters

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

9

SAST

Determines if the project uses static code analysis.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 6

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/check_pr_title.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/check_pr_title.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-hotfix-branch.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/create-hotfix-branch.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-npm.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-npm.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-npm.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-npm.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-sanity-suite.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-sanity-suite.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-sanity-suite.yml:93: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy-sanity-suite.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:102: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/deploy.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/draft-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/draft-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:146: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/draft-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/housekeeping.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/housekeeping.yaml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/housekeeping.yaml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/housekeeping.yaml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-new-release.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/publish-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-new-release.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/publish-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollback.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/rollback.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollback.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/rollback.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollback.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/rollback.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollback.yml:121: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/rollback.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/security-code-quality-and-bundle-size-checks.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/security-code-quality-and-bundle-size-checks.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/trigger-test-suites.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/trigger-test-suites.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-tests-and-lint.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/unit-tests-and-lint.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-tests-and-lint.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/rudderlabs/rudder-sdk-js/unit-tests-and-lint.yml/develop?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/draft-new-release.yml:104
Info: 0 out of 25 GitHub-owned GitHubAction dependencies pinned
Info: 15 out of 17 third-party GitHubAction dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.8

/10

Last Scanned on 2025-04-28

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to rudder-sdk-js

Other packages similar to rudder-sdk-js

rudder-sdk-js

Installations

Developer Guide

Yes

CommonJS, ESM

20.11.1

10.2.4

Pull Requests

7

2,101

313

1,781

Issues

0

93

93

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

130.13 kB

37.82 kB

Maintainers

Package Meta Information

Total Downloads

12,290,114

Weekly Downloads

Monthly Downloads

Yearly Downloads

RudderStack JavaScript SDK

Table of Contents

Installing the JavaScript SDK

Minified code

Non-minified code

Write key and data plane URL

Alternative installation using NPM

Exported APIs

Sample implementations

Supported browser versions

Identifying users

Tracking user actions

The ready API

Self-Hosted control plane

Adding your own integrations

How to build the SDK

Usage in Chrome Extensions

Usage in Serverless Runtimes

License

Contribute

Contact us

Follow Us

:clap: Our Supporters

10

10

10

10

10

9

9

6

5

5

0

0

0

6.8

/10

The `ready` API