Giter Site home page Giter Site logo

rxjs-signalr's Introduction

RxJS wrapper for ASP.NET SignalR

CircleCI

When consuming SignalR based services I wanted to be able to treat receiving data as an observable stream. This library provides a thin wrapper to allow consumption of SignalR services using RxJS Observables.

What is RxJS?

Refer to the RxJS docs for that.

What is SignalR?

Refer to the ASP.NET SignalR docs.

Getting started

rxjs and Signalr

This package relies on signalr and rxjs packages.

Install

Install using npm:

npm install observable-signalr --save

Creating a hub

Create using factory method:

import { createSignalRHub } from 'observable-signalr';

const hub = createSignalRHub('{hubName}');

Create using constructor:

import { SignalRHub } from 'observable-signalr';

const hub = new SignalRHub('{hubName}');

Receiving data from SignalR

import { createSignalRHub } from 'observable-signalr';

const hub = createSignalRHub('{hubName}');
hub.on('{name of event/method}').subscribe(data => {
    // Perform logic here
});
hub.start();

Sending data to SignalR

import { createSignalRHub } from 'observable-signalr';

const hub = createSignalRHub('{hubName}');
hub.start();
hub.send('{name of event/method}', {});

rxjs-signalr's People

Contributors

bryceklinker avatar spontifixus avatar jlzapata avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.