Pingerchips JavaScript SDK

Real-time WebSocket client for Pingerchips.

Installation

npm install pingerchips-js

Usage

Basic Connection

import Pingerchips from 'pingerchips-js';

const client = new Pingerchips('your_app_key', {
  endpoint: 'wss://pinger-processor.pingerchips.com/socket'
});

Subscribe to Public Channels

const channel = await client.subscribe('lobby');

channel.bind('message', (data) => {
  console.log('Received:', data);
});

channel.trigger('message', { text: 'Hello!' });

Subscribe to Private Channels

For private channels, you need to configure an auth endpoint:

const client = new Pingerchips('your_app_key', {
  endpoint: 'wss://pinger-processor.pingerchips.com/socket',
  authEndpoint: 'https://your-server.com/auth',
  authInfo: {
    userId: '123',
    token: 'user-session-token'
  }
});

const privateChannel = await client.subscribe('private-chat');

Subscribe to Presence Channels

const presenceChannel = await client.subscribe('presence-lobby');

presenceChannel.bind('user-joined', (data) => {
  console.log('User joined:', data.user_info);
});

Configuration Options

| Option | Type | Description | |--------|------|-------------| | endpoint | string | WebSocket endpoint URL | | authEndpoint | string | Your server's auth endpoint for private/presence channels | | authInfo | object | User authentication info passed to your auth endpoint | | authHeaders | object | Additional headers for auth requests |

Authentication

For private and presence channels, you must implement an auth endpoint on your server. See pingerchips-js-server for server-side implementation.

Channel Methods

bind(event, callback)

Listen for events on a channel.

channel.bind('message', (data) => {
  console.log(data);
});

trigger(event, data)

Send an event to a channel.

channel.trigger('message', { text: 'Hello!' });

unbind(event)

Stop listening for an event.

channel.unbind('message');

License

MIT