A reactive programming library for JavaScript
TypeScript JavaScript Other
Latest commit 31cf2bf Jan 16, 2017 @kwonoj kwonoj committed on GitHub Merge pull request #2224 from kwonoj/feat-fromeventpattern
Align fromEventPattern behavior to RxJS v4
Permalink
Failed to load latest commit information.
.github fix(Rx): remove kitchenSink and DOM, let Rx export all Apr 30, 2016
doc docs(tutorial): wrong keyboard event (#2242) Jan 13, 2017
perf test(sequenceEqual): add micro perf tests Aug 16, 2016
spec test(fromEventPattern): simplify test fixture using mocks Jan 15, 2017
src feat(fromEventPattern): support optional removeHandler Jan 15, 2017
tools chore(package.json): Use TypeScript to bundle UMD directly (#2093) Oct 31, 2016
.editorconfig Add .editorconfig, reindent some files with spaces Jul 19, 2015
.eslintrc chore(package.json): update package dependencies Jan 29, 2016
.gitignore refactor(symbol-observable): bump up symbol-observable@1 (#1772) Jun 16, 2016
.jshintrc finally add jshint Apr 9, 2015
.make-packages.js feat(ES2015): stop publishing `rxjs-es` Oct 11, 2016
.markdown-doctest-setup.js fix(fromEvent): Throw if event target is invalid (#2107) Nov 5, 2016
.npmignore chore(package.json): bump up package dependencies (#2042) Oct 25, 2016
.travis.yml chore(travis): faster build turnaround (#2236) Jan 5, 2017
CHANGELOG.md chore(publish): 5.0.3 Jan 5, 2017
CODE_OF_CONDUCT.md chore: add code of conduct Jul 17, 2015
CONTRIBUTING.md docs(doctoc): using doctoc to generate ToC May 7, 2016
LICENSE.txt chore(license): add Microsoft to copyright Apr 5, 2016
MAINTAINERS chore(MAINTAINERS): fix user names Jul 5, 2016
MIGRATION.md docs(MIGRATION.md): Add sample/sampleTime operator split (#2268) Jan 13, 2017
README.md chore(README): Update our branching strategy (#2205) Dec 21, 2016
esdoc.json docs(esdoc.json): related to #1871, Rx.umd.js is now just Rx.js (#1878) Aug 12, 2016
index.js fix(Rx): remove kitchenSink and DOM, let Rx export all Apr 30, 2016
package.json chore(package.json): replace ghooks into husky (#2259) Jan 13, 2017
protractor.conf.js fix(benchpress): update benchpress dependencies and config Oct 5, 2015
publish_docs.sh style(docs): improve readability of publish_docs (#2015) Oct 24, 2016
tsconfig.json style(linting): enable 'noImplicitThis' compiler option (#2103) Nov 9, 2016
tslint.json chore(package.json): auto fix possible lint errors when commit (#2250) Jan 5, 2017
typings.json chore(typings): update type definition dependencies Nov 11, 2016
wallaby.js refactor(ajax tests): remove separate ajaxHelper module (#2225) Jan 5, 2017

README.md

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

Selenium Test Status

RxJS 5

Reactive Extensions Library for JavaScript. This is a rewrite of Reactive-Extensions/RxJS and is intended to supersede it once this is ready. 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 - commits that will be included in the next minor or patch release
  • next - commits that will be included in the next major release (breaking changes)

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

npm install rxjs

To import the entire core set of functionality:

import Rx from 'rxjs/Rx';

Rx.Observable.of(1,2,3)

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

import { Observable } from 'rxjs/Observable';
import 'rxjs/add/observable/of';
import 'rxjs/add/operator/map';

Observable.of(1,2,3).map(x => x + '!!!'); // etc

To import what you need and use it with proposed bind operator:

Note: This additional syntax requires transpiler support and this syntax may be completely withdrawn from TC39 without notice! Use at your own risk.

import { Observable } from 'rxjs/Observable';
import { of } from 'rxjs/observable/of';
import { map } from 'rxjs/operator/map';

Observable::of(1,2,3)::map(x => x + '!!!'); // etc

CommonJS via npm

npm install rxjs

Import all core functionality:

var Rx = require('rxjs/Rx');

Rx.Observable.of(1,2,3); // etc

Import only what you need and patch Observable (this is useful in size-sensitive bundling scenarios):

var Observable = require('rxjs/Observable').Observable;
// patch Observable with appropriate methods
require('rxjs/add/observable/of');
require('rxjs/add/operator/map');

Observable.of(1,2,3).map(function (x) { return x + '!!!'; }); // etc

Import operators and use them manually you can do the following (this is also useful for bundling):

var of = require('rxjs/observable/of').of;
var map = require('rxjs/operator/map').map;

map.call(of(1,2,3), function (x) { return x + '!!!'; });

You can also use the above method to build your own Observable and export it from your own module.

All Module Types (CJS/ES6/AMD/TypeScript) via npm

To install this library via npm version 3, use the following command:

npm install @reactivex/rxjs

If you are using npm version 2 before this library has achieved a stable version, you need to specify the library version explicitly:

npm install @reactivex/rxjs@5.0.0

CDN

For CDN, you can use unpkg:

5.0.0-beta.1 - 5.0.0-beta.11:

https://unpkg.com/@reactivex/rxjs/dist/global/Rx.umd.js

5.0.0-beta.12 or higher:

https://unpkg.com/@reactivex/rxjs/dist/global/Rx.js

Node.js Usage:

var Rx = require('@reactivex/rxjs');

Rx.Observable.of('hello world')
  .subscribe(function(x) { console.log(x); });

Goals

  • 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

The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:

  • build_es6: Transpiles the TypeScript files from src/ to dist/es6
  • build_cjs: Transpiles the ES6 files from dist/es6 to dist/cjs
  • build_amd: Transpiles the ES6 files from dist/es6 to dist/amd
  • build_global: Transpiles/Bundles the CommonJS files from dist/cjs to dist/global/Rx.js
  • build_all: Performs all of the above in the proper order.
  • build_test: builds ES6, then CommonJS, then runs the tests with jasmine
  • build_perf: builds ES6, CommonJS, then global, then runs the performance tests with protractor
  • build_docs: generates API documentation from dist/es6 to dist/docs
  • build_cover: runs istanbul code coverage against test cases
  • test: runs tests with jasmine, must have built prior to running.
  • tests2png: generates PNG marble diagrams from test cases.

npm run info will list available script.

Example

# build all the things!
npm run build_all

Performance Tests

Run npm run build_perf or npm run perf to run the performance tests with protractor. Run npm run perf_micro 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.

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: