aspnetcore/clients/ts/signalr
Andrew Stanton-Nurse b1fccab7b1
Merge pull request #2203 from aspnet/release/2.1
switch tests to 'jest' (#2193)
2018-05-04 12:57:19 -07:00
..
build
src switch tests to 'jest' (#2193) 2018-05-04 12:51:33 -07:00
tests switch tests to 'jest' (#2193) 2018-05-04 12:51:33 -07:00
README.md
package-lock.json
package.json Merge pull request #2203 from aspnet/release/2.1 2018-05-04 12:57:19 -07:00
rollup.config.js
tsconfig.json switch tests to 'jest' (#2193) 2018-05-04 12:51:33 -07:00

README.md

JavaScript and TypeScript clients for SignalR for ASP.NET Core

Installation

npm install @aspnet/signalr

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 (Browser)

let connection = new signalR.HubConnection('/chat');

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

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

Example (NodeJS)

const signalR = require("@aspnet/signalr");

let connection = new signalR.HubConnection('/chat');

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

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