ReactiveX/rxjs

Name: rxjs

Owner: ReactiveX

Description: A reactive programming library for JavaScript

Created: 2015-03-15 06:17:10.0

Updated: 2018-01-17 23:49:44.0

Pushed: 2018-01-17 15:20:35.0

Homepage: http://reactivex.io/rxjs

Size: 76889

Language: TypeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Build Status Coverage Status npm version Join the chat at https://gitter.im/Reactive-Extensions/RxJS

Selenium Test Status

RxJS 6 Alpha

FOR V 5.X PLEASE GO TO STABLE BRANCH

Reactive Extensions Library for JavaScript. This is a rewrite of Reactive-Extensions/RxJS and is the latest production-ready version of RxJS. This rewrite is meant to have better performance, better modularity, better debuggable call stacks, while staying mostly backwards compatible, with some breaking changes that reduce the API surface.

Apache 2.0 License

Versions In This Repository

Most PRs should be made to master, unless you know it is a breaking change.

Important

By contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the Contributor Code of Conduct. Much like traffic laws, ignorance doesn't grant you immunity.

Installation and Usage
ES6 via npm
install rxjs@alpha

To import the entire core set of functionality:

rt Rx from 'rxjs/Rx';

bservable.of(1,2,3)

To import only what you need by patching (this is useful for size-sensitive bundling):

rt { Observable, Subject, ReplaySubject } from 'rxjs';
rt { from, of, range } from 'rxjs/create';
rt { map, filter, switchMap } from 'rxjs/operators';

e(1, 200)
ipe(filter(x => x % 2 === 1), map(x => x + x))
ubscribe(x => console.log(x));
CommonJS via npm

To install this library for CommonJS (CJS) usage, use the following command:

install rxjs@alpha

(Note: destructuring available in Node 8+)

t { Observable, Subject, ReplaySubject } = require('rxjs');
t { from, of, range } = require('rxjs/create');
t { map, filter, switchMap } = require('rxjs/operators');

e(1, 200)
ipe(filter(x => x % 2 === 1), map(x => x + x))
ubscribe(x => console.log(x));
CDN

For CDN, you can use unpkg:

https://unpkg.com/rxjs/bundles/Rx.min.js

Node.js Usage:
Rx = require('@reactivex/rxjs');

bservable.of('hello world')
ubscribe(function(x) { console.log(x); });
Goals
Building/Testing

npm run info will list available scripts (there are a lot LOL)

Performance Tests

Run npm run build_perf or npm run perf to run the performance tests with protractor.

Run npm run perf_micro [operator] to run micro performance test benchmarking operator.

Adding documentation

RxNext uses ESDoc to generate API documentation. Refer to ESDoc's documentation for syntax. Run npm run build_docs to generate.

At the moment we are trying to improve the documentation. For this purpose the Documentation is in a seperate GitHub Repostory. For a quick instruction take a look at the documentation guidelines. We are really happy about any type of contributions!

Generating PNG marble diagrams

The script npm run tests2png requires some native packages installed locally: imagemagick, graphicsmagick, and ghostscript.

For Mac OS X with Homebrew:

For Debian Linux:

For Windows and other Operating Systems, check the download instructions here:


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.