Most PRs should be made to master, unless you know it is a breaking change.
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.
npm install rxjs
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 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.
;;;Observable::of123::; // etc
To install this library for CommonJS (CJS) usage, use the following command:
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 of = of;var map = map;map;
You can also use the above method to build your own Observable and export it from your own module.
To install this library via npm version 3, use the following command:
npm install @reactivex/rxjs
This will include CJS/Global builds and can be used for all module types.
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 @firstname.lastname@example.org
For CDN, you can use unpkg:
var Rx = ;RxObservable;
The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:
istanbulcode coverage against test cases
jasmine, must have built prior to running.
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.
npm run tests2png requires some native packages installed locally:
For Mac OS X with Homebrew:
brew install imagemagick
brew install graphicsmagick
brew install ghostscript
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: