An open API service indexing awesome lists of open source software.

https://github.com/streamerbot/client

Streamer.bot WebSocket client
https://github.com/streamerbot/client

streamerbot typescript websocket

Last synced: 11 months ago
JSON representation

Streamer.bot WebSocket client

Awesome Lists containing this project

README

          

# Streamer.bot Client

TypeScript client for interacting with the [Streamer.bot](https://streamer.bot) WebSocket API

[![npm (scoped)](https://img.shields.io/npm/v/@streamerbot/client)](https://www.npmjs.com/package/@streamerbot/client) [![npm](https://img.shields.io/npm/dt/@streamerbot/client)](https://www.npmjs.com/package/@streamerbot/client) [![docs](https://img.shields.io/badge/-Documentation-blue)](https://streamerbot.github.io/client)

[Full Documentation](https://streamerbot.github.io/client/)

## 🌈 Demo
All functionality on [Streamer.bot Toolkit](https://toolkit.streamer.bot) is utilizing this client library 😍

## 📦 Installation

Package Manager

```
yarn add @streamerbot/client

npm install @streamerbot/client

pnpm install @streamerbot/client
```

CDN / Browser

```

```

## 🦄 Basic Usage

```ts
import { StreamerbotClient } from '@streamerbot/client';

// Create a new client with default options
const client = new StreamerbotClient();

// Subscription will automatically be added to client with your listener function
client.on('Twitch.ChatMessage', (data) => {
console.log('Twitch Chat Message Received!', data);
});
```

Check out the [docs](https://streamerbot.github.io/client/) for more usage examples.

## 🌸 Thanks

Huge thanks to [nate1280](https://github.com/nate1280) for creating Streamer.bot!

## 👨‍🚀 Contributors
[Whipstickgostop](https://github.com/whipstickgostop)

## 📄 License
MIT License © 2023-Present [Whipstickgostop](https://github.com/whipstickgostop)