JavaScript

The Chirpier SDK for JavaScript is a simple, lightweight, and efficient SDK to emit event data to Chirpier direct from your JavaScript applications.

Installation

Install Chirpier SDK using npm:

npm install @chirpier/chirpier-js

Getting Started

To start using the SDK, you need to initialize it with your API key. The SDK works in both browser and Node.js environments.

Here’s a quick example of how to use the Chirpier SDK:

import { initialize, monitor, Event } from '@chirpier/chirpier-js';
 
// Initialize the SDK with your API key
initialize({ key: 'your-api-key', region: 'us-west' });
 
// Send a data stream tied to a group of streams
monitor({
  group_id: '02e4f4d8-415e-4fc1-b01a-677ac5bc9207',
  stream_name: 'My measurement',
  value: 15.30,
} as Event);

API Reference

Initialize

Initialize the Chirpier client with your API key and region. Find your API key in the Chirpier Integration page.

initialize({ key: 'your-api-key', region: 'region' });

• your-api-key (str): Your Chirpier integration key
• region (str): Your local region - options are us-west, eu-west, asia-southeast

Event

All events emitted to Chirpier must have the following properties:

event = {
  group_id: '02e4f4d8-415e-4fc1-b01a-677ac5bc9207',
  stream_name: 'My measurement',
  value: 15.3,
};

• group_id (str): UUID of the monitoring group
• stream_name (str): Name of the measurement stream
• value (float): Numeric value to record

Emit

Send an event to Chirpier using the monitor function.

monitor(event);