piesocket-nodejs

PieSocket NodeJS Server SDK

A NodeJS Library for PieSocket Channels.

PieSocket Channels are a medium for clients and servers to communicate in real-time. Client-to-client communications are also supported.

Note: This package is PieSocket Server SDK, if you are looking for Client SDK (to use with Frontend on browsers), please see PieSocketJS.

Installation

Yarn

yarn add piesocket-nodejs

NPM

npm i piesocket-nodejs

Importing

Import module:

const PieSocket = require("piesocket-nodejs");

Publishing messages

1. Initialize the PieSocket class:

var piesocket = new PieSocket({
    clusterId: 'YOUR_CLUSTER_ID',
    apiKey: 'YOUR_API_KEY',
    secret: 'YOUR_API_SECRET'
});

2. Publish events:

piesocket.publish("channel", "event-name" , data, meta);

Channel ID can be a string or number, data should be JSON. meta can be null or JSON.

Supported Methods

List of available methods on the PieSocket object

Method	Description	Returns
publish(channel ,event ,data ,meta)	Publish an event to a channel	Promise

Configuration

Complete list of allowed configuration options

Option	Description	Default
apiKey	Your PieSocket API key	null
clusterId	Your API key's cluster ID	demo
secret	Your PieSocket API key	null

Reference

• PieSocketJS: PieSocket Browser SDK
• Documentation: PieSocket WebSocket docs