RxJS 5 (beta)
- Code of Conduct
- Contribution Guidelines
- Maintainer Guidelines
- Creating Operators
- Migrating From RxJS 4 to RxJS 5
- API Documentation (WIP)
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-es
To import the entire core set of functionality:
To import only what you need by patching (this is useful for size-sensitive bundling):
;;Observable; // etc
To import what you need and use it with ES next function bind (best overall method, if possible):
;;Observable::; // etc
CommonJS via npm
npm install rxjs
Import all core functionality:
var Rx = ;RxObservable; // etc
Import only what you need and patch Observable (this is useful in size-sensitive bundling scenarios):
var Observable = Observable;// patch Observable with appropriate methods;Observable; // etc
Import operators and use them manually you can do the following (this is also useful for bundling):
var Observable = Observable;var map = map;map;
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 @email@example.com
For CDN, you can use unpkg:
5.0.0-beta.1 - 5.0.0-beta.11:
5.0.0-beta.12 or higher:
var Rx = ;RxObservable;
- 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
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
- build_cjs: Transpiles the ES6 files from
- build_amd: Transpiles the ES6 files from
- build_global: Transpiles/Bundles the CommonJS files from
- build_all: Performs all of the above in the proper order.
- build_test: builds ES6, then CommonJS, then runs the tests with
- build_perf: builds ES6, CommonJS, then global, then runs the performance tests with
- build_docs: generates API documentation from
- build_cover: runs
istanbulcode 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.
# build all the things!npm run build_all
npm run build_perf or
npm run perf to run the performance tests with
npm run perf_micro to run micro performance test benchmarking operator.
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
npm run tests2png requires some native packages installed locally:
For Mac OS X with Homebrew:
brew install imagemagick
brew install graphicsmagick
brew install 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: