Package Exports

@ssv/signalr-client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ssv/signalr-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ssv.signalr-client

SignalR client library built on top of `@aspnet/signalr-client. This gives you more features and easier to use.

Features:

todo

Quick links

Change logs | Project Repository

Installation

Get library via npm

npm install @ssv/signalr-client --save

Usage

TODO

Getting Started

Setup Machine for Development

Install/setup the following:

NodeJS v9+
Visual Studio Code or similar code editor
TypeScript 2.6+
Git + SourceTree, SmartGit or similar (optional)
Ensure to install global NPM modules using the following:

npm install -g git gulp yarn

Cloning Repo

Run git clone https://github.com/sketch7/ssv.signalr-client.git

Project Setup

The following process need to be executed in order to get started.

npm install

Building the code

gulp build
// or
npm run build

In order to view all other tasks invoke gulp or check the gulp tasks directly.

Running the tests

gulp test
// or
npm test

Development utils

Trigger gulp watch

Handles compiling of changes.

gulp watch
// or
npm start

Running Continuous Tests

Spawns test runner and keep watching for changes.

gulp tdd
// or
npm run tdd

Preparation for Release

npm run prepare-release -- --bump major|minor|patch|prerelease (default: patch)

Check out the release workflow guide in order to guide you creating a release and publishing it.