node package manager
Orgs are free. Discover, share, and reuse code in your team. Create a free org »

@aspnet/signalr-client

JavaScript and TypeScript clients for SignalR for ASP.NET Core

Installation

npm install @aspnet/signalr-client

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.

Node.js

The following polyfills are required to use the client in Node.js applications:

  • XmlHttpRequest - always
  • WebSockets - to use the WebSockets transport
  • EventSource - to use the ServerSentEvents transport
  • btoa/atob - to use binary protocols (e.g. MessagePack) over text transports (ServerSentEvents)

Example

let connection = new signalR.HubConnection('/chat');
 
connection.on('send', data => {
    console.log(data);
});
 
connection.start()
    .then(() => connection.invoke('send', 'Hello'));