carina
Version:
A NodeJS and Browser compatible client for Mixer.com's constellation socket.
74 lines (60 loc) • 1.48 kB
Markdown
You can either use npm (recommended) or download the zip from the [releases page](https://github.com/mixer/carina/releases).
### Browser
```html
<script src="js/carina.js"></script>
```
```
npm i --save carina
```
```html
<doctype html>
<html>
<head>
<title>Carina</title>
</head>
<body>
<script src="js/carina.js"></script>
<script src="js/app.js"></script>
</body>
</html>
```
```js
var ca = new carina.Carina().open();
ca.subscribe('channel:1:update', function (data) {
console.log('Channel update', data);
});
```
```js
const Carina = require('carina').Carina;
const ws = require('ws');
Carina.WebSocket = ws;
// Note: You MUST set isBot if the client is
// an automated bot and you are NOT authing.
const ca = new Carina({ isBot: true }).open();
ca.subscribe('channel:1:update', data => {
console.log('Channel update', data);
});
```
```ts
import { Carina } from 'carina';
import * as ws from 'ws';
Carina.WebSocket = ws;
const ca = new Carina({ isBot: true }).open();
ca.subscribe<ChannelUpdate>('channel:1:update', data => {
console.log('Channel update', data);
});
// Example interface, does not contain all possible values.
interface ChannelUpdate {
online?: boolean;
}
```