Package Exports
- @segment/analytics-node
- @segment/analytics-node/dist/cjs/index.js
- @segment/analytics-node/dist/esm/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@segment/analytics-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@segment/analytics-node
https://www.npmjs.com/package/@segment/analytics-node
OFFICIAL DOCUMENTATION (FULL)
LEGACY NODE SDK MIGRATION GUIDE:
Runtime Support
- Node.js >= 18
- AWS Lambda
- Cloudflare Workers
- Vercel Edge Functions
- Web Workers / Browser (no device mode destination support)
Quick Start
Install library
# npm
npm install @segment/analytics-node
# yarn
yarn add @segment/analytics-node
# pnpm
pnpm install @segment/analytics-node
Usage
Assuming some express-like web framework.
import { Analytics } from '@segment/analytics-node'
// or, if you use require:
const { Analytics } = require('@segment/analytics-node')
// instantiation
const analytics = new Analytics({ writeKey: '<MY_WRITE_KEY>' })
app.post('/login', (req, res) => {
analytics.identify({
userId: req.body.userId,
previousId: req.body.previousId
})
res.sendStatus(200)
})
app.post('/cart', (req, res) => {
analytics.track({
userId: req.body.userId,
event: 'Add to cart',
properties: { productId: '123456' }
})
res.sendStatus(201)
});
See our official documentation for more examples and information.
Settings & Configuration
See the documentation: https://segment.com/docs/connections/sources/catalog/libraries/server/node/#configuration
You can also see the complete list of settings in the AnalyticsSettings interface.