@microsoft/signalr-protocol-msgpack
v8.0.7
Published
MsgPack Protocol support for ASP.NET Core SignalR
Downloads
80,385
Readme
MsgPack support for SignalR for ASP.NET Core
Installation
npm install @microsoft/signalr-protocol-msgpack
# or
yarn add @microsoft/signalr-protocol-msgpack
To try previews of the next version, use the next
tag on NPM:
npm install @microsoft/signalr-protocol-msgpack@next
# or
yarn add @microsoft/signalr-protocol-msgpack@next
Usage
See the SignalR Documentation at learn.microsoft.com for documentation on the latest release. API Reference Documentation is also available on learn.microsoft.com.
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.
NodeJS
To use the client in a NodeJS application, install the package to your node_modules
folder and use require('@microsoft/signalr-protocol-msgpack')
to load the module. The object returned by require('@microsoft/signalr-protocol-msgpack')
has the same members as the global signalR.protocols.msgpack
object (when used in a browser).
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("@microsoft/signalr");
const signalRMsgPack = require("@microsoft/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'));