{ "bugs": { "url": "https://github.com/ReactiveX/RxJS/issues" }, "license": "Apache-2.0", "contributors": [ { "name": "Ben Lesh", "email": "blesh@netflix.com" }, { "name": "Paul Taylor", "email": "paul.e.taylor@me.com" }, { "name": "Jeff Cross", "email": "crossj@google.com" }, { "name": "Matthew Podwysocki", "email": "matthewp@microsoft.com" }, { "name": "OJ Kwon", "email": "kwon.ohjoong@gmail.com" }, { "name": "Andre Staltz", "email": "andre@staltz.com" } ], "version": "5.0.0-beta.6", "repository": { "type": "git", "url": "git+ssh://git@github.com/ReactiveX/RxJS.git" }, "keywords": [ "Rx", "RxJS", "ReactiveX", "ReactiveExtensions", "Streams", "Observables", "Observable", "Stream", "ES6", "ES2015" ], "config": { "commitizen": { "path": "node_modules/cz-conventional-changelog" }, "ghooks": { "commit-msg": "node ./node_modules/validate-commit-msg/index.js" } }, "engines": { "npm": ">=2.0.0" }, "description": "Reactive Extensions for modern JavaScript", "scripts-info": { "info": "List available script", "build_all": "Build all packages(ES6, CJS, AMD, Global) and generate packages", "build_amd": "Build AMD package with clean up existing build, copy source into dist", "build_cjs": "Build CJS package with clean up existing build, copy source into dist", "build_es6": "Build ES6 package with clean up existing build, copy source into dist", "build_closure_core": "Minify Global core build using closure compiler", "build_closure_kitchensink": "Minify Global kitchenSink build using closure compiler", "build_global": "Build Global package, then minify core & kitchensink build", "build_perf": "Build CJS & Global build, run macro performance test", "build_test": "Build CJS package & test spec, execute mocha test runner", "build_cover": "Run lint to current code, build CJS & test spec, execute test coverage", "build_docs": "Build ES6 & global package, create documentation using it", "build_spec": "Build test specs", "check_circular_dependencies": "Check codebase has circular dependencies", "clean_spec": "Clean up existing test spec build output", "clean_dist_amd": "Clean up existing AMD package output", "clean_dist_cjs": "Clean up existing CJS package output", "clean_dist_es6": "Clean up existing ES6 package output", "commit": "Run git commit wizard", "compile_dist_amd": "Compile codebase into AMD module", "compile_dist_cjs": "Compile codebase into CJS module", "compile_dist_es6": "Compile codebase into ES6", "cover": "Execute test coverage", "lint_perf": "Run lint against performance test suite", "lint_spec": "Run lint against test spec", "lint_src": "Run lint against source", "lint": "Run lint against everything", "perf": "Run macro performance benchmark", "perf_micro": "Run micro performance benchmark", "test_mocha": "Execute mocha test runner against existing test spec build", "test_browser": "Execute mocha test runner on browser against existing test spec build", "test": "Clean up existing test spec build, build test spec and execute mocha test runner", "tests2png": "Generate marble diagram image from test spec", "watch": "Watch codebase, trigger compile when source code changes" }, "main": "Rx.js", "name": "rxjs", "homepage": "https://github.com/ReactiveX/RxJS", "typings": "Rx.d.ts", "author": { "name": "Ben Lesh", "email": "blesh@netflix.com" }, "devDependencies": { "babel-polyfill": "^6.7.2", "benchmark": "^2.1.0", "benchpress": "2.0.0-beta.1", "browserify": "13.0.0", "chai": "^3.5.0", "color": "^0.11.1", "colors": "1.1.2", "commitizen": "^2.7.2", "coveralls": "^2.11.8", "cz-conventional-changelog": "1.1.5", "esdoc": "^0.4.6", "eslint": "^2.4.0", "fs-extra": "^0.26.5", "ghooks": "^1.0.3", "glob": "^7.0.3", "gm": "1.21.1", "google-closure-compiler": "^20160208.5.0", "gzip-size": "^3.0.0", "http-server": "^0.9.0", "istanbul": "0.4.2", "lodash": "^4.6.1", "madge": "^0.5.3", "markdown-doctest": "^0.3.2", "minimist": "^1.2.0", "mkdirp": "^0.5.1", "mocha": "^2.4.5", "mocha-in-sauce": "0.0.1", "npm-run-all": "^1.5.3", "npm-scripts-info": "^0.3.4", "opn-cli": "^3.1.0", "platform": "^1.3.1", "promise": "^7.1.1", "protractor": "^3.1.1", "remap-istanbul": "0.5.1", "rx": "latest", "sinon": "^2.0.0-pre", "sinon-chai": "^2.8.0", "source-map-support": "^0.4.0", "systemjs": "^0.19.24", "systemjs-builder": "^0.10.6", "tslint": "^3.5.0", "typescript": "^1.8.7", "typings": "^0.7.8", "validate-commit-msg": "^2.3.1", "watch": "^0.17.1", "watchify": "3.7.0", "webpack": "^1.12.14", "xmlhttprequest": "1.8.0" }, "_id": "rxjs@5.0.0-beta.6", "scripts": {}, "_shasum": "cb6dc46d6ddfedfeefc9b15dafd09c34a4370d23", "_from": "rxjs@5.0.0-beta.6", "_npmVersion": "3.7.3", "_nodeVersion": "5.0.0", "_npmUser": { "name": "blesh", "email": "ben@benlesh.com" }, "dist": { "shasum": "cb6dc46d6ddfedfeefc9b15dafd09c34a4370d23", "tarball": "https://registry.npmjs.org/rxjs/-/rxjs-5.0.0-beta.6.tgz" }, "maintainers": [ { "name": "blesh", "email": "ben@benlesh.com" }, { "name": "jeffbcross", "email": "middlefloor@gmail.com" } ], "_npmOperationalInternal": { "host": "packages-12-west.internal.npmjs.com", "tmp": "tmp/rxjs-5.0.0-beta.6.tgz_1460493695519_0.9258141233585775" }, "directories": {}, "_resolved": "https://registry.npmjs.org/rxjs/-/rxjs-5.0.0-beta.6.tgz", "readme": "[![Build Status](https://travis-ci.org/ReactiveX/rxjs.svg?branch=master)](https://travis-ci.org/ReactiveX/rxjs)\n[![Coverage Status](https://coveralls.io/repos/ReactiveX/RxJS/badge.svg?branch=master&service=github)](https://coveralls.io/github/ReactiveX/RxJS?branch=master)\n[![npm version](https://badge.fury.io/js/%40reactivex%2Frxjs.svg)](http://badge.fury.io/js/%40reactivex%2Frxjs)\n[![Join the chat at https://gitter.im/Reactive-Extensions/RxJS](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Reactive-Extensions/RxJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\n[![Selenium Test Status](https://saucelabs.com/browser-matrix/rxjs5.svg)](https://saucelabs.com/u/rxjs5)\n\n# RxJS 5 (beta)\n\nReactive Extensions Library for JavaScript. This is a rewrite of [Reactive-Extensions/RxJS](https://github.com/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.\n\n[Apache 2.0 License](LICENSE.txt)\n\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Contribution Guidelines](CONTRIBUTING.md)\n- [Maintainer Guidelines](doc/maintainer-guidelines.md)\n- [Creating Operators](doc/operator-creation.md)\n- [Migrating From RxJS 4 to RxJS 5](MIGRATION.md)\n- [API Documentation (WIP)](http://reactivex.io/rxjs)\n\n## Important\n\nBy contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity.\n\n## Installation and Usage\n\n### ES6 via npm\n\n```sh\nnpm install rxjs-es\n```\n\nTo import the entire core set of functionality:\n\n```js\nimport Rx from 'rxjs/Rx';\n\nRx.Observable.of(1,2,3)\n```\n\nTo import only what you need by patching (this is useful for size-sensitive bundling):\n\n```js\nimport {Observable} from 'rxjs/Observable';\nimport 'rxjs/add/operator/map';\n\nObservable.of(1,2,3).map(x => x + '!!!'); // etc\n```\n\nTo import what you need and use it with ES next function bind (best overall method, if possible):\n\n```js\nimport {Observable} from 'rxjs/Observable';\nimport {map} from 'rxjs/operator/map';\n\nObservable.of(1,2,3)::map(x => x + '!!!'); // etc\n```\n\n### CommonJS via npm\n\n```sh\nnpm install rxjs\n```\n\nImport all core functionality:\n\n```js\nvar Rx = require('rxjs/Rx');\n\nRx.Observable.of(1,2,3); // etc\n```\n\nImport only what you need and patch Observable (this is useful in size-sensitive bundling scenarios):\n\n```js\nvar Observable = require('rxjs/Observable').Observable;\n// patch Observable with appropriate methods\nrequire('rxjs/add/operator/map');\n\nObservable.of(1,2,3).map(function (x) { return x + '!!!'; }); // etc\n```\n\nImport operators and use them _manually_ you can do the following (this is also useful for bundling):\n\n```js\nvar Observable = require('rxjs/Observable').Observable;\nvar map = require('rxjs/operator/map').map;\n\nmap.call(Observable.of(1,2,3), function (x) { return x + '!!!'; });\n```\n\nYou can also use the above method to build your own Observable and export it from your own module.\n\n\n### All Module Types (CJS/ES6/AMD/TypeScript) via npm\n\nTo install this library via [npm](https://www.npmjs.org) **version 3**, use the following command:\n\n```sh\nnpm install @reactivex/rxjs\n```\n\nIf you are using npm **version 2** before this library has achieved a stable version, you need to specify the library version explicitly:\n\n```sh\nnpm install @reactivex/rxjs@5.0.0-beta.1\n```\n\n### CDN\n\nFor CDN, you can use [npmcdn](https://npmcdn.com). Just replace `version` with the current\nversion on the link below:\n\nhttps://npmcdn.com/@reactivex/rxjs@version/dist/global/Rx.umd.js\n\n#### Node.js Usage:\n\n```js\nvar Rx = require('@reactivex/rxjs');\n\nRx.Observable.of('hello world')\n .subscribe(function(x) { console.log(x); });\n```\n\n## Goals\n\n- Provide better performance than preceding versions of RxJS\n- To model/follow the [Observable Spec Proposal](https://github.com/zenparsing/es-observable) to the observable.\n- Provide more modular file structure in a variety of formats\n- Provide more debuggable call stacks than preceding versions of RxJS\n\n## Building/Testing\n\nThe build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:\n\n- build_es6: Transpiles the TypeScript files from `src/` to `dist/es6`\n- build_cjs: Transpiles the ES6 files from `dist/es6` to `dist/cjs`\n- build_amd: Transpiles the ES6 files from `dist/es6` to `dist/amd`\n- build_global: Transpiles/Bundles the CommonJS files from `dist/cjs` to `dist/global/Rx.js`\n- build_all: Performs all of the above in the proper order.\n- build_test: builds ES6, then CommonJS, then runs the tests with `jasmine`\n- build_perf: builds ES6, CommonJS, then global, then runs the performance tests with `protractor`\n- build_docs: generates API documentation from `dist/es6` to `dist/docs`\n- build_cover: runs `istanbul` code coverage against test cases\n- test: runs tests with `jasmine`, must have built prior to running.\n- tests2png: generates PNG marble diagrams from test cases.\n\n`npm run info` will list available script.\n\n### Example\n\n```sh\n# build all the things!\nnpm run build_all\n```\n\n## Performance Tests\n\nRun `npm run build_perf` or `npm run perf` to run the performance tests with `protractor`.\nRun `npm run perf_micro` to run micro performance test benchmarking operator.\n\n## Adding documentation\nRxNext uses [ESDoc](https://esdoc.org/) to generate API documentation. Refer to ESDoc's documentation for syntax. Run `npm run build_docs` to generate.\n\n## Generating PNG marble diagrams\n\nThe script `npm run tests2png` requires some native packages installed locally: `imagemagick`, `graphicsmagick`, and `ghostscript`.\n\nFor Mac OS X with [Homebrew](http://brew.sh/):\n\n- `brew install imagemagick`\n- `brew install graphicsmagick`\n- `brew install ghostscript`\n\nFor Debian Linux:\n\n- `sudo add-apt-repository ppa:dhor/myway`\n- `apt-get install imagemagick`\n- `apt-get install graphicsmagick`\n- `apt-get install ghostscript`\n\nFor Windows and other Operating Systems, check the download instructions here:\n\n- http://imagemagick.org\n- http://www.graphicsmagick.org\n- http://www.ghostscript.com/\n", "readmeFilename": "README.md" }