aspnetcore/client-ts
BrennanConroy de535422d7 Optional error and complete functions for observables (#1000) 2017-10-10 16:42:50 -07:00
..
Microsoft.AspNetCore.SignalR.Client.TS Optional error and complete functions for observables (#1000) 2017-10-10 16:42:50 -07:00
Microsoft.AspNetCore.SignalR.Client.TS.Tests Optional error and complete functions for observables (#1000) 2017-10-10 16:42:50 -07:00
Microsoft.AspNetCore.SignalR.Test.Server Fixing JS end-to-end tests 2017-10-04 12:04:08 -07:00
typings
.npmignore Adding README to npm module 2017-09-18 10:08:52 -07:00
README.md Adding README to npm module 2017-09-18 10:08:52 -07:00
package-lock.json
package.json

README.md

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'));