Ohm-Management - Projektarbeit B-ME
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 5.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <img src="doc/asset/Rx_Logo_S.png" alt="RxJS Logo" width="86" height="86"> RxJS: Reactive Extensions For JavaScript
  2. ======================================
  3. [![Build Status](https://travis-ci.org/ReactiveX/rxjs.svg?branch=master)](https://travis-ci.org/ReactiveX/rxjs)
  4. [![Coverage Status](https://coveralls.io/repos/github/ReactiveX/rxjs/badge.svg?branch=master)](https://coveralls.io/github/ReactiveX/rxjs?branch=master)
  5. [![npm version](https://badge.fury.io/js/%40reactivex%2Frxjs.svg)](http://badge.fury.io/js/%40reactivex%2Frxjs)
  6. [![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)
  7. [![Selenium Test Status](https://saucelabs.com/browser-matrix/rxjs5.svg)](https://saucelabs.com/u/rxjs5)
  8. # RxJS 6 Stable
  9. ### MIGRATION AND RELEASE INFORMATION:
  10. Find out how to update to v6, **automatically update your TypeScript code**, and more!
  11. - [Current home is MIGRATION.md](./docs_app/content/guide/v6/migration.md)
  12. ### FOR V 5.X PLEASE GO TO [THE 5.0 BRANCH](https://github.com/ReactiveX/rxjs/tree/5.x)
  13. Reactive Extensions Library for JavaScript. This is a rewrite of [Reactive-Extensions/RxJS](https://github.com/Reactive-Extensions/RxJS) and is the latest production-ready version of RxJS. 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.
  14. [Apache 2.0 License](LICENSE.txt)
  15. - [Code of Conduct](CODE_OF_CONDUCT.md)
  16. - [Contribution Guidelines](CONTRIBUTING.md)
  17. - [Maintainer Guidelines](doc/maintainer-guidelines.md)
  18. - [Creating Operators](doc/operator-creation.md)
  19. - [API Documentation (WIP)](https://rxjs.dev/)
  20. ## Versions In This Repository
  21. - [master](https://github.com/ReactiveX/rxjs/commits/master) - This is all of the current, unreleased work, which is against v6 of RxJS right now
  22. - [stable](https://github.com/ReactiveX/rxjs/commits/stable) - This is the branch for the latest version you'd get if you do `npm install rxjs`
  23. ## Important
  24. 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](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity.
  25. ## Installation and Usage
  26. ### ES6 via npm
  27. ```sh
  28. npm install rxjs
  29. ```
  30. It's recommended to pull in the Observable creation methods you need directly from `'rxjs'` as shown below with `range`. And you can pull in any operator you need from one spot, under `'rxjs/operators'`.
  31. ```js
  32. import { range } from 'rxjs';
  33. import { map, filter } from 'rxjs/operators';
  34. range(1, 200).pipe(
  35. filter(x => x % 2 === 1),
  36. map(x => x + x)
  37. ).subscribe(x => console.log(x));
  38. ```
  39. Here, we're using the built-in `pipe` method on Observables to combine operators. See [pipeable operators](https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md) for more information.
  40. ### CommonJS via npm
  41. To install this library for CommonJS (CJS) usage, use the following command:
  42. ```sh
  43. npm install rxjs
  44. ```
  45. (Note: destructuring available in Node 8+)
  46. ```js
  47. const { range } = require('rxjs');
  48. const { map, filter } = require('rxjs/operators');
  49. range(1, 200).pipe(
  50. filter(x => x % 2 === 1),
  51. map(x => x + x)
  52. ).subscribe(x => console.log(x));
  53. ```
  54. ### CDN
  55. For CDN, you can use [unpkg](https://unpkg.com/):
  56. https://unpkg.com/rxjs/bundles/rxjs.umd.min.js
  57. The global namespace for rxjs is `rxjs`:
  58. ```js
  59. const { range } = rxjs;
  60. const { map, filter } = rxjs.operators;
  61. range(1, 200).pipe(
  62. filter(x => x % 2 === 1),
  63. map(x => x + x)
  64. ).subscribe(x => console.log(x));
  65. ```
  66. ## Goals
  67. - Smaller overall bundles sizes
  68. - Provide better performance than preceding versions of RxJS
  69. - To model/follow the [Observable Spec Proposal](https://github.com/zenparsing/es-observable) to the observable
  70. - Provide more modular file structure in a variety of formats
  71. - Provide more debuggable call stacks than preceding versions of RxJS
  72. ## Building/Testing
  73. - `npm run build_all` - builds everything
  74. - `npm test` - runs tests
  75. - `npm run test_no_cache` - run test with `ts-node` set to false
  76. ## Performance Tests
  77. Run `npm run build_perf` or `npm run perf` to run the performance tests with `protractor`.
  78. Run `npm run perf_micro [operator]` to run micro performance test benchmarking operator.
  79. ## Adding documentation
  80. We appreciate all contributions to the documentation of any type. All of the information needed to get the docs app up and running locally as well as how to contribute can be found in the [documentation directory](./docs_app).
  81. ## Generating PNG marble diagrams
  82. The script `npm run tests2png` requires some native packages installed locally: `imagemagick`, `graphicsmagick`, and `ghostscript`.
  83. For Mac OS X with [Homebrew](http://brew.sh/):
  84. - `brew install imagemagick`
  85. - `brew install graphicsmagick`
  86. - `brew install ghostscript`
  87. - You may need to install the Ghostscript fonts manually:
  88. - Download the tarball from the [gs-fonts project](https://sourceforge.net/projects/gs-fonts)
  89. - `mkdir -p /usr/local/share/ghostscript && tar zxvf /path/to/ghostscript-fonts.tar.gz -C /usr/local/share/ghostscript`
  90. For Debian Linux:
  91. - `sudo add-apt-repository ppa:dhor/myway`
  92. - `apt-get install imagemagick`
  93. - `apt-get install graphicsmagick`
  94. - `apt-get install ghostscript`
  95. For Windows and other Operating Systems, check the download instructions here:
  96. - http://imagemagick.org
  97. - http://www.graphicsmagick.org
  98. - http://www.ghostscript.com/