Kabelwerk JavaScript SDK

https://docs.kabelwerk.io/sdk-js/
Admin
Kabelwerk JavaScript SDK is a low-level SDK for JavaScript that enables real-time communication...
Tokens:811
Snippets:10
Trust Score:5.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Kabelwerk SDK with npm

Source: https://docs.kabelwerk.io/sdk-js

Install the SDK using npm. This is the primary method for adding the Kabelwerk SDK to your project.

```bash
npm install kabelwerk  
```

--------------------------------

### Install Kabelwerk SDK with pnpm

Source: https://docs.kabelwerk.io/sdk-js

Install the SDK using pnpm. This is another alternative package manager for installing the SDK.

```bash
pnpm add kabelwerk  
```

--------------------------------

### Install Kabelwerk SDK with Yarn

Source: https://docs.kabelwerk.io/sdk-js

Install the SDK using Yarn. This provides an alternative package management option.

```bash
yarn add kabelwerk  
```

--------------------------------

### Establish Kabelwerk Connection

Source: https://docs.kabelwerk.io/sdk-js

Initialize and connect to the Kabelwerk backend using the Kabelwerk object. Configure with your URL and token, then listen for 'ready' and 'error' events.

```javascript
import Kabelwerk from 'kabelwerk';  
  
Kabelwerk.config({ url, token });  
  
Kabelwerk.on('ready', () => {  
    // this event is fired once when the initial connection is established  
    let inbox = Kabelwerk.openInbox();  
    let room = Kabelwerk.openRoom();  
});  
  
Kabelwerk.on('error', (error) => {  
    // e.g. when the token is invalid  
});  
  
Kabelwerk.connect();  
```

--------------------------------

### Interact with Chat Rooms

Source: https://docs.kabelwerk.io/sdk-js

Open a specific room to post and retrieve messages. Handle 'ready' and 'message_posted' events, and use 'postMessage' and 'loadEarlier' for message operations.

```javascript
let room = Kabelwerk.openRoom(roomId);  
  
room.on('ready', ({ messages }) => {  
    // this event is fired once when the room is loaded  
});  
  
room.on('message_posted', (message) => {  
    // this event is fired every time a new message is posted in this room  
});  
  
room.connect();  
  
room.postMessage({ text })  
    .then((message) => {  
        // you will also get the same message via the `message_posted` event  
    })  
    .catch((error) => {  
        // e.g. when the server rejects the message  
    });  
  
room.loadEarlier()  
    .then(({ messages }) => {  
        // resolves into the list of messages which come right before the earliest  
        // message seen by the room object  
    })  
    .catch((error) => {  
        // if there are no more messages, you will get an empty list, not an error  
    });  
```

--------------------------------

### Manage Inboxes

Source: https://docs.kabelwerk.io/sdk-js

Open an inbox to view and manage rooms, ordered by message recency. Listen for 'ready' and 'updated' events to track changes in the inbox items.

```javascript
let inbox = Kabelwerk.openInbox();  
  
inbox.on('ready', ({ items }) => {  
    // this event is fired once when the initial list of inbox items is loaded  
});  
  
inbox.on('updated', ({ items }) => {  
    // whenever a new message is posted, the list of inbox items is updated  
    // accordingly and this event is fired  
});  
  
inbox.connect();  
```
Tokens:
Raw