Installation

CloudSignal MQTT client is available as an npm package and via CDN for browser use.

npm / yarn / pnpm

npm install @cloudsignal/mqtt-client

yarn add @cloudsignal/mqtt-client

pnpm add @cloudsignal/mqtt-client

CDN (Browser)

For browser environments without a bundler, include the script directly:

<script src="https://cdn.cloudsignal.io/cloudsignal-mqtt.v2.1.0.js"></script>

This exposes CloudSignal as a global variable:

const client = new CloudSignal({
  organizationId: 'your-org-id'
});

unpkg

You can also use unpkg as an alternative CDN:

<script src="https://unpkg.com/@cloudsignal/mqtt-client"></script>

Package Formats

The library ships with multiple formats:

• ESM (dist/index.js) - For modern bundlers and ES modules
• CJS (dist/index.cjs) - For Node.js require() usage
• IIFE (dist/index.global.js) - For browser script tags

Your bundler will automatically select the right format based on your import style.

Requirements

• Browser: Modern browsers with WebSocket support
• Node.js: v16 or later (for server-side usage)

TypeScript Support

TypeScript definitions are included in the package. No additional @types/* package needed.

import { CloudSignalClient, CloudSignalConfig } from '@cloudsignal/mqtt-client';

const config: CloudSignalConfig = {
  organizationId: 'your-org-id',
  debug: true
};

const client = new CloudSignalClient(config);