aspnetcore/client-ts/signalr-protocol-msgpack/README.md

46 lines
997 B
Markdown

MsgPack support for SignalR for ASP.NET Core
## Installation
```bash
npm install @aspnet/signalr-protocol-msgpack
```
## Usage
### Browser
To use the client in a browser, copy `*.js` files from the `dist/browser` folder to your script folder include on your page using the `<script>` tag.
### Example (Browser)
```JavaScript
let connection = new signalR.HubConnection('/chat', {
protocol: new signalR.protocol.msgpack.MessagePackHubProtocol()
});
connection.on('send', data => {
console.log(data);
});
connection.start()
.then(() => connection.invoke('send', 'Hello'));
```
### Example (NodeJS)
```JavaScript
const signalR = require("@aspnet/signalr");
const signalRMsgPack = require("@aspnet/signalr-protocol-msgpack");
let connection = new signalR.HubConnection('/chat', {
protocol: new signalRMsgPack.MessagePackHubProtocol()
});
connection.on('send', data => {
console.log(data);
});
connection.start()
.then(() => connection.invoke('send', 'Hello'));
```