A reactive programming library for JavaScript
TypeScript JavaScript CSS HTML Shell Dockerfile Python
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github chore(github): don't comment on locked issues (#3804) Jun 7, 2018
compat docs(AsapScheduler): update make docs more accurate Aug 14, 2018
doc docs(AsapScheduler): update make docs more accurate Aug 14, 2018
docs_app docs(UI): Spacing Between Heading and Badges (#4018) Aug 16, 2018
integration/systemjs refactor(webSocket): rename back to webSocket ala 5.0 (#3590) Apr 20, 2018
legacy-reexport feat(compat): add Observable extension classes with static create() Apr 6, 2018
migrations fix(migrations): change the version the migration applies to (#3564) Apr 13, 2018
node-tests fix(node): Subscriber no longer trampled if from another copy of rxjs Mar 26, 2018
perf fix(lint_perf): fix lint issues with newer perf tests Mar 30, 2018
spec-dtslint chore(dtslint): disable no-unnecessary-generics (#4012) Aug 13, 2018
spec fix(distinctUntilKeyChanged): improved key typing with keyof T (#3988) Aug 6, 2018
src docs(fromEventPattern): add missing backticks (#4024) Aug 15, 2018
tools chore(build): Build a umd bundle of rxjs-compat Jun 23, 2018
tsconfig chore(build): Build a umd bundle of rxjs-compat Jun 23, 2018
.dependency-cruiser.json fix(compat): deprecate Observable.if/throw (#3527) Apr 5, 2018
.editorconfig Add .editorconfig, reindent some files with spaces Jul 19, 2015
.eslintrc chore(package.json): update package dependencies Jan 29, 2016
.gitattributes refactor(typings): updated typings to support symbol observables and … Feb 20, 2018
.gitignore refactor(compat): make build and tests pass Mar 15, 2018
.jshintrc finally add jshint Apr 9, 2015
.make-compat-package.js fix(sourcemaps): fix mappings for source maps so they will work (#3523) Apr 7, 2018
.make-helpers.js fix(sourcemaps): fix mappings for source maps so they will work (#3523) Apr 7, 2018
.make-packages.js refactor(webSocket): rename back to webSocket ala 5.0 (#3590) Apr 20, 2018
.markdown-doctest-setup.js refactor(test): updated test helpers to be strongly typed (#3265) Feb 14, 2018
.npmignore build(docs): remove docs app from published node modules (#3777) Jun 4, 2018
.travis.yml chore(TS): moves to use TypeScript@latest (#4007) Aug 14, 2018
CHANGELOG.md chore(publish): 6.2.2 Jul 13, 2018
CODE_OF_CONDUCT.md chore(CodeOfConduct): Update Code of Conduct (#3148) Dec 1, 2017
CONTRIBUTING.md docs(contribution): describe briefly new documentation (#3778) Jun 7, 2018
LICENSE.txt chore(license): Updated year range to 2018 (#3207) Jan 8, 2018
MAINTAINERS chore(MAINTAINERS): fix user names Jul 5, 2016
MIGRATION.md docs(content): add migration guide (#3781) Jun 4, 2018
README.md fix small typo (#3986) Aug 3, 2018
appveyor.yml build(package): bump npm on ci May 8, 2018
dangerfile.js feat(umd): UMD now mirrors export schema for ESM and CJS (#3426) Mar 13, 2018
esdoc.json docs(esdoc.json): related to #1871, Rx.umd.js is now just Rx.js (#1878) Aug 12, 2016
index.js feat(package): rxjs distribution now supports main, module and es2015… Sep 17, 2017
package-lock.json chore(TS): moves to use TypeScript@latest (#4007) Aug 14, 2018
package.json chore(TS): moves to use TypeScript@latest (#4007) Aug 14, 2018
protractor.conf.js fix(benchpress): update benchpress dependencies and config Oct 5, 2015
publish.sh chore(publish.sh): update publish script to disallow publishing master Jan 12, 2018
publish_docs.sh style(docs): improve readability of publish_docs (#2015) Oct 24, 2016
tsconfig.base.json perf: remove comments from js-files (#3760) Jun 4, 2018
tsconfig.json refactor(compat): make build and tests pass Mar 15, 2018
tsconfig.vscode.json New Documentation (#3763) May 31, 2018
tslint.json refactor(types): change AnonymousSubscription & ISubscription to Unsu… Feb 22, 2018
wallaby.js chore(package): update test scripts Oct 25, 2017

README.md

RxJS Logo RxJS: Reactive Extensions For JavaScript

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

Selenium Test Status

RxJS 6 Stable

MIGRATION AND RELEASE INFORMATION:

Find out how to update to v6, automatically update your TypeScript code, and more!

FOR V 5.X PLEASE GO TO THE 5.0 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

  • master - This is all of the current, unreleased work, which is against v6 of RxJS right now
  • stable - This is the branch for the latest version you'd get if you do npm install rxjs

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

npm install rxjs

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

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

range(1, 200)
  .pipe(filter(x => x % 2 === 1), map(x => x + x))
  .subscribe(x => console.log(x));

Alternatively, you can use the built-in pipe method on Observables. See pipeable operators for more information.

CommonJS via npm

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

npm install rxjs

(Note: destructuring available in Node 8+)

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

range(1, 200)
  .pipe(filter(x => x % 2 === 1), map(x => x + x))
  .subscribe(x => console.log(x));

CDN

For CDN, you can use unpkg:

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

The global namespace for rxjs is rxjs:

const { Observable, Subject, ReplaySubject, from, of, range } = rxjs;
const { map, filter, switchMap } = rxjs.operators;

range(1, 200)
  .pipe(filter(x => x % 2 === 1), map(x => x + x))
  .subscribe(x => console.log(x));

Goals

  • Smaller overall bundles sizes
  • Provide better performance than preceding versions of RxJS
  • To model/follow the Observable Spec Proposal to the observable.
  • Provide more modular file structure in a variety of formats
  • Provide more debuggable call stacks than preceding versions of RxJS

Building/Testing

  • npm run build_all - builds everything
  • npm test - runs tests

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 separate GitHub Repository. 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:

  • brew install imagemagick
  • brew install graphicsmagick
  • brew install ghostscript
  • You may need to install the Ghostscript fonts manually:
    • Download the tarball from the gs-fonts project
    • mkdir -p /usr/local/share/ghostscript && tar zxvf /path/to/ghostscript-fonts.tar.gz -C /usr/local/share/ghostscript

For Debian Linux:

  • sudo add-apt-repository ppa:dhor/myway
  • apt-get install imagemagick
  • apt-get install graphicsmagick
  • apt-get install ghostscript

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