Skip to content
Branch: master
Find file History

Latest commit

JunTaoLuo Merge pull request #20421 from dotnet/johluo/migrate-more-extensions-…
…logging

Johluo/migrate more extensions logging
Latest commit 8fac707 Apr 3, 2020

Files

Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
clients fix #13651 by logging serialization failures as error (#20116) Apr 3, 2020
common Merge pull request #20421 from dotnet/johluo/migrate-more-extensions-… Apr 3, 2020
docs Merge remote-tracking branch 'origin/release/3.1' Oct 23, 2019
perf Merge branch 'master' into johluo/migrating-extensions Feb 21, 2020
samples Merge branch 'master' into johluo/migrating-extensions Feb 21, 2020
server fix #13651 by logging serialization failures as error (#20116) Apr 3, 2020
.vsconfig Add .vsconfig files in root and beside slns Mar 31, 2020
Directory.Build.props Relocate Logging.Testing to AspNetCore.Testing Apr 2, 2020
Directory.Build.targets Make Visual Studio 2019 a prerequisite to building this repo (#7005) Feb 20, 2019
README.md Update wording (#17757) Dec 11, 2019
SignalR.sln Replace Internal.AspNetCore.Sdk with Microsoft.DotNet.Arcade.Sdk (#10674 Jun 8, 2019
THIRD-PARTY-NOTICES Reorganize source code in preparation to move into aspnet/AspNetCore Nov 27, 2018
build.cmd Check for Java in local SignalR build (#10455) May 22, 2019
build.sh Merge branch 'release/2.2' Jan 11, 2019
publish-apps.ps1 [master] Update dependencies from 3 repositories (#12977) Aug 28, 2019
splat-browser-logs.ps1 Merge branch 'release/2.2' Jan 11, 2019
startvs.cmd Convert SignalR projects to build with ProjectReference (#6457) Jan 9, 2019
xunit.runner.json Use xunit.runner.json in Helix runs (#19922) Mar 17, 2020

README.md

ASP.NET Core SignalR

ASP.NET Core SignalR is a library for ASP.NET Core developers that makes it incredibly simple to add real-time web functionality to your applications. What is "real-time web" functionality? It's the ability to have your server-side code push content to the connected clients as it happens, in real-time.

You can watch an introductory presentation here - ASP.NET Core SignalR: Build 2018

Documentation

Documentation for ASP.NET Core SignalR can be found in the Real-time Apps section of the ASP.NET Core Documentation site.

TypeScript Version

If you are encountering TypeScript definition issues with SignalR, please ensure you are using the latest version of TypeScript to compile your application. If the issue occurs in the latest TypeScript, please let us know.

When in doubt, check the version of TypeScript referenced by our package.json file. That version is the minimum TypeScript version expected to work with SignalR.

Packages

You can install the latest released JavaScript client from npm with the following command:

npm install @microsoft/signalr

The @microsoft/signalr package (and it's dependencies) require NPM 5.6.0 or higher.

NOTE: Previous versions of the SignalR client were named @aspnet/signalr or @aspnet/signalr-client.

IMPORTANT: When using preview builds, you should always ensure you are using the same version of both the JavaScript client and the Server. The version numbers should align as they are produced in the same build process.

The CI build publishes the latest dev version of the JavaScript client to our dev npm registry as @microsoft/signalr. You can install the module as follows:

  • Create an .npmrc file with the following line: @microsoft:registry=https://dotnet.myget.org/f/aspnetcore-dev/npm/
  • Run: npm install @microsoft/signalr

Alternatively, if you don't want to create the .npmrc file run the following commands:

npm install @microsoft/signalr --registry https://dotnet.myget.org/f/aspnetcore-dev/npm/

We also have a MsgPack protocol library which is installed via:

npm install @microsoft/signalr-protocol-msgpack

Deploying

Once you've installed the NPM modules, they will be located in the node_modules/@microsoft/signalr and node_modules/@microsoft/signalr-protocol-msgpack folders. If you are building a NodeJS application or using an ECMAScript module loader/bundler (such as webpack), you can load them directly. If you are building a browser application without using a module bundler, you can find UMD-compatible bundles in the dist/browser folder; minified versions are provided as well. Simply copy these to your project as appropriate and use a build task to keep them up-to-date.

You can’t perform that action at this time.