Naming Prosecution Mitigator
Miss any of our Open RFC calls?Watch the recordings here! »

rxjs-es6

5.0.0-alpha.12 • Public • Published

Build Status Coverage Status npm version

RxJS 5 (alpha)

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

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

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-alpha.10

CDN

For CDN, you can use npmcdn. Just replace version with the current version on the link below:

https://npmcdn.com/@reactivex/rxjs@version/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 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
  • 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.

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

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:

Install

npm i rxjs-es6

DownloadsWeekly Downloads

1

Version

5.0.0-alpha.12

License

Apache-2.0

Last publish

Collaborators

  • avatar
  • avatar