@rudderstack/analytics-js-service-worker
v3.1.16
Published
RudderStack JavaScript Service Worker SDK
Downloads
23,379
Readme
@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 Node.js SDK.
For detailed documentation on the RudderStack JavaScript SDK, click here.
Table of Contents
Installing the package
To install the package via NPM, run the following command:
npm install @rudderstack/analytics-js-service-worker --saveimport { Analytics } from '@rudderstack/analytics-js-service-worker';
const rudderClient = new Analytics('<WRITE_KEY>', '<DATA_PLANE_URL>');| 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 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:
How to build the SDK
Look for run scripts in the
package.jsonfile for getting the browser minified and non-minified builds. The builds are updated in thedistfolder of the directory. Among the others, some of the important ones are:npm run build:package: This command outputs the dist/npm folder that contains the NPM package contents.
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.