Overview
PulseGrid JavaScript is the official npm package for trusted backend and Node.js usage.
Use this package when you want to:
- test authentication
- create client tokens
- list or create channels
- publish server-side messages
- connect to channels over websocket
- check presence from JavaScript
Important:
This package is best suited for backend or trusted Node.js usage.
Do not expose your PulseGrid secretKey in browser or mobile client code.
Setup
1. Make sure Node.js is installed.
2. Open your terminal in your project.
3. Install PulseGrid from npm.
4. Verify the import works.
5. Then move on to the JavaScript quick start docs.
Code example
# Install the package
npm install pulsegrid
# Check that it is installed
npm list pulsegrid
# Simple import test
node -e "import('pulsegrid').then(m => console.log(typeof m.createPulseGrid === 'function' ? 'PulseGrid JS import ok' : 'Import failed'))"
Notes
Expected result examples:
npm list pulsegrid
may show something like:
your-project-name
└── pulsegrid@0.1.0
Import test:
PulseGrid JS import ok
If import fails, confirm your Node.js project supports ESM import syntax.