RxJS 5 (alpha)

Reactive Extensions Library for JavaScript

Apache 2.0 License

• Code of Conduct
• Contribution Guidelines
• Maintainer Guidelines
• Creating Operators

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

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

npm install @reactivex/rxjs

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 ES7 Observable Spec 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
• test: runs tests with jasmine, must have built prior to running.

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.

Adding documentation

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