aspnetcore/clients/ts/signalr-protocol-msgpack
James Newton-King 30a59f6df7
TypeScript strict mode (#2388)
2018-05-31 12:04:48 +12:00
..
src TypeScript strict mode (#2388) 2018-05-31 12:04:48 +12:00
tests TypeScript strict mode (#2388) 2018-05-31 12:04:48 +12:00
README.md update README for npm packages (#2216) 2018-05-07 09:14:24 -07:00
package-lock.json
package.json Embed version in the JavaScript client (#2229) 2018-05-11 12:54:30 -07:00
rollup.config.js
tsconfig.json switch tests to 'jest' (#2193) 2018-05-04 12:51:33 -07:00

README.md

MsgPack support for SignalR for ASP.NET Core

Installation

npm install @aspnet/signalr-protocol-msgpack

Usage

See the SignalR Documentation at docs.microsoft.com for documentation on the latest release.

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)

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chat")
    .withHubProtocol(new signalR.protocols.msgpack.MessagePackHubProtocol())
    .build();

connection.on('send', data => {
    console.log(data);
});

connection.start()
    .then(() => connection.invoke('send', 'Hello'));

Example (NodeJS)

const signalR = require("@aspnet/signalr");
const signalRMsgPack = require("@aspnet/signalr-protocol-msgpack");

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chat")
    .withHubProtocol(new signalRMsgPack.MessagePackHubProtocol())
    .build();

connection.on('send', data => {
    console.log(data);
});

connection.start()
    .then(() => connection.invoke('send', 'Hello'));