Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basementuniverse/jsonpad-realtime-sdk
JSONPad Realtime SDK for Node and browser
https://github.com/basementuniverse/jsonpad-realtime-sdk
Last synced: 23 days ago
JSON representation
JSONPad Realtime SDK for Node and browser
- Host: GitHub
- URL: https://github.com/basementuniverse/jsonpad-realtime-sdk
- Owner: basementuniverse
- License: mit
- Created: 2024-11-17T03:03:41.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-14T23:32:40.000Z (24 days ago)
- Last Synced: 2024-12-14T23:43:44.291Z (24 days ago)
- Language: TypeScript
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSONPad Realtime SDK
This package allows you to connect to JSONPad Realtime and get realtime updates when your lists or items change.
## Installation
```bash
npm install @basementuniverse/jsonpad-realtime-sdk
```
## Usage
Create an instance of the JSONPad Realtime SDK and pass in your API token:
Node (JS):
```js
const JSONPadRealtime = require('@basementuniverse/jsonpad-realtime-sdk').default;
const jsonpadRealtime = new JSONPadRealtime('your-api-token');
```
Node (TS):
```ts
import JSONPadRealtime from '@basementuniverse/jsonpad-realtime-sdk';
const jsonpadRealtime = new JSONPadRealtime('your-api-token');
```
Browser:
```html
const jsonpadRealtime = new JSONPadRealtime.default('your-api-token');
```
Next, start listening for events on your lists or items:
```js
jsonpadRealtime.listen(
[
'list-created',
'list-updated',
'list-deleted',
'item-created',
'item-updated',
'item-restored',
'item-deleted',
]
);
```
Attach event listeners to the JSONPad Realtime SDK instance:
```js
jsonpadRealtime.addEventListener('list-created', e => {
console.log(`A list called ${e.detail.model.name} was created!`);
});
```
If you want to stop listening for events and disconnect from the server, you can call the `close` method:
```js
jsonpadRealtime.close();
```
## `listen()` method
The `listen()` method takes an array of event types to listen for. You can pass in any of the following event types:
- `list-created`
- `list-updated`
- `list-deleted`
- `item-created`
- `item-updated`
- `item-restored`
- `item-deleted`
You can also optionally pass in an array of list ids and item ids to listen for.
You can include `*` in the list ids and item ids arrays to listen for all lists or items.
```js
jsonpadRealtime.listen(
[
'list-created',
'list-updated',
'list-deleted',
'item-created',
'item-updated',
'item-restored',
'item-deleted',
],
[
'86059de7-9b16-4469-a630-23c8f69944b6',
'a2c706a6-5212-4e8a-92ad-bce1beea153f',
],
[
'e0bc4797-303a-49ff-b7b4-18781cc2460e',
'06ad5a22-c002-4c67-92bc-83ec85014461',
]
);
```
## Event types
- `list-created`: A list was created.
- `list-updated`: A list was updated.
- `list-deleted`: A list was deleted.
- `item-created`: An item was created.
- `item-updated`: An item was updated.
- `item-restored`: An item was restored.
- `item-deleted`: An item was deleted.
## Event object
The event object passed to the event listener has the following properties:
```ts
{
type: string;
details: {
listId: string;
itemId: string;
model: any; // This will be a List or Item, depending on the event type
};
}
```