\href{https://circleci.com/gh/ReactiveX/rxjs/tree/6.x}{\texttt{ }} \href{http://badge.fury.io/js/\%40reactivex\%2Frxjs}{\texttt{ }} \href{https://gitter.im/Reactive-Extensions/RxJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge}{\texttt{ }}\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26019}{}\doxysection{Rx\+JS 6 Stable}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26019}
\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26020}{}\doxysubsubsection{MIGRATION AND RELEASE INFORMATION\+:}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26020}
Find out how to update to v6, {\bfseries{automatically update your Type\+Script code}}, and more!


\begin{DoxyItemize}
\item Current home is MIGRATION.md
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26021}{}\doxysubsubsection{FOR V 5.\+X PLEASE GO TO $<$a href=\char`\"{}https\+://github.\+com/\+Reactive\+X/rxjs/tree/5.\+x\char`\"{}$>$\+THE 5.\+0 BRANCH$<$/a$>$}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26021}
Reactive Extensions Library for Java\+Script. This is a rewrite of \href{https://github.com/Reactive-Extensions/RxJS}{\texttt{ Reactive-\/\+Extensions/\+Rx\+JS}} and is the latest production-\/ready version of Rx\+JS. 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.

\href{LICENSE.txt}{\texttt{ Apache 2.\+0 License}}


\begin{DoxyItemize}
\item Code of Conduct
\item Contribution Guidelines
\item Maintainer Guidelines
\item \href{https://rxjs.dev/}{\texttt{ API Documentation}}
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26022}{}\doxysubsection{Versions In This Repository}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26022}

\begin{DoxyItemize}
\item \href{https://github.com/ReactiveX/rxjs/commits/master}{\texttt{ master}} -\/ This is all of the current, unreleased work, which is against v6 of Rx\+JS right now
\item \href{https://github.com/ReactiveX/rxjs/commits/stable}{\texttt{ stable}} -\/ This is the branch for the latest version you\textquotesingle{}d get if you do {\ttfamily npm install rxjs}
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26023}{}\doxysubsection{Important}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26023}
By contributing or commenting on issues in this repository, whether you\textquotesingle{}ve read them or not, you\textquotesingle{}re agreeing to the Contributor Code of Conduct. Much like traffic laws, ignorance doesn\textquotesingle{}t grant you immunity.\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26024}{}\doxysubsection{Installation and Usage}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26024}
\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26025}{}\doxysubsubsection{ES6 via npm}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26025}

\begin{DoxyCode}{0}
\DoxyCodeLine{npm install rxjs }

\end{DoxyCode}


It\textquotesingle{}s recommended to pull in the Observable creation methods you need directly from `\textquotesingle{}rxjs'{\ttfamily as shown below with}range{\ttfamily . And you can pull in any operator you need from one spot, under}\textquotesingle{}rxjs/operators\textquotesingle{}\`{}.


\begin{DoxyCode}{0}
\DoxyCodeLine{import \{ range \} from "{}rxjs"{};}
\DoxyCodeLine{import \{ map, filter \} from "{}rxjs/operators"{};}
\DoxyCodeLine{}
\DoxyCodeLine{range(1, 200)}
\DoxyCodeLine{  .pipe(}
\DoxyCodeLine{    filter(x => x \% 2 === 1),}
\DoxyCodeLine{    map(x => x + x)}
\DoxyCodeLine{  )}
\DoxyCodeLine{  .subscribe(x => console.log(x)); }

\end{DoxyCode}


Here, we\textquotesingle{}re using the built-\/in {\ttfamily pipe} method on Observables to combine operators. See \href{https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md}{\texttt{ pipeable operators}} for more information.\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26026}{}\doxysubsubsection{Common\+JS via npm}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26026}
To install this library for Common\+JS (CJS) usage, use the following command\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{npm install rxjs }

\end{DoxyCode}


(Note\+: destructuring available in Node 8+)


\begin{DoxyCode}{0}
\DoxyCodeLine{const \{ range \} = require('rxjs');}
\DoxyCodeLine{const \{ map, filter \} = require('rxjs/operators');}
\DoxyCodeLine{}
\DoxyCodeLine{range(1, 200).pipe(}
\DoxyCodeLine{  filter(x => x \% 2 === 1),}
\DoxyCodeLine{  map(x => x + x)}
\DoxyCodeLine{).subscribe(x => console.log(x)); }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26027}{}\doxysubsubsection{CDN}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26027}
For CDN, you can use \href{https://unpkg.com/}{\texttt{ unpkg}}\+:

\href{https://unpkg.com/rxjs/bundles/rxjs.umd.min.js}{\texttt{ https\+://unpkg.\+com/rxjs/bundles/rxjs.\+umd.\+min.\+js}}

The global namespace for rxjs is {\ttfamily rxjs}\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{const \{ range \} = rxjs;}
\DoxyCodeLine{const \{ map, filter \} = rxjs.operators;}
\DoxyCodeLine{}
\DoxyCodeLine{range(1, 200)}
\DoxyCodeLine{  .pipe(}
\DoxyCodeLine{    filter(x => x \% 2 === 1),}
\DoxyCodeLine{    map(x => x + x)}
\DoxyCodeLine{  )}
\DoxyCodeLine{  .subscribe(x => console.log(x)); }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26028}{}\doxysubsection{Goals}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26028}

\begin{DoxyItemize}
\item Smaller overall bundles sizes
\item Provide better performance than preceding versions of Rx\+JS
\item To model/follow the \href{https://github.com/zenparsing/es-observable}{\texttt{ Observable Spec Proposal}} to the observable
\item Provide more modular file structure in a variety of formats
\item Provide more debuggable call stacks than preceding versions of Rx\+JS
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26029}{}\doxysubsection{Building/\+Testing}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26029}

\begin{DoxyItemize}
\item {\ttfamily npm run build\+\_\+all} -\/ builds everything
\item {\ttfamily npm test} -\/ runs tests
\item {\ttfamily npm run test\+\_\+no\+\_\+cache} -\/ run test with {\ttfamily ts-\/node} set to false
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26030}{}\doxysubsection{Performance Tests}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26030}
Run {\ttfamily npm run build\+\_\+perf} or {\ttfamily npm run perf} to run the performance tests with {\ttfamily protractor}.

Run {\ttfamily npm run perf\+\_\+micro \mbox{[}operator\mbox{]}} to run micro performance test benchmarking operator.\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26031}{}\doxysubsection{Adding documentation}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26031}
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 \href{./docs_app}{\texttt{ documentation directory}}.\hypertarget{md_sfcode_node_modules_rxjs_README_autotoc_md26032}{}\doxysubsection{Generating PNG marble diagrams}\label{md_sfcode_node_modules_rxjs_README_autotoc_md26032}
The script {\ttfamily npm run tests2png} requires some native packages installed locally\+: {\ttfamily imagemagick}, {\ttfamily graphicsmagick}, and {\ttfamily ghostscript}.

For Mac OS X with \href{http://brew.sh/}{\texttt{ Homebrew}}\+:


\begin{DoxyItemize}
\item {\ttfamily brew install imagemagick}
\item {\ttfamily brew install graphicsmagick}
\item {\ttfamily brew install ghostscript}
\item You may need to install the Ghostscript fonts manually\+:
\begin{DoxyItemize}
\item Download the tarball from the \href{https://sourceforge.net/projects/gs-fonts}{\texttt{ gs-\/fonts project}}
\item {\ttfamily mkdir -\/p /usr/local/share/ghostscript \&\& tar zxvf /path/to/ghostscript-\/fonts.tar.\+gz -\/C /usr/local/share/ghostscript}
\end{DoxyItemize}
\end{DoxyItemize}

For Debian Linux\+:


\begin{DoxyItemize}
\item {\ttfamily sudo add-\/apt-\/repository ppa\+:dhor/myway}
\item {\ttfamily apt-\/get install imagemagick}
\item {\ttfamily apt-\/get install graphicsmagick}
\item {\ttfamily apt-\/get install ghostscript}
\end{DoxyItemize}

For Windows and other Operating Systems, check the download instructions here\+:


\begin{DoxyItemize}
\item \href{http://imagemagick.org}{\texttt{ http\+://imagemagick.\+org}}
\item \href{http://www.graphicsmagick.org}{\texttt{ http\+://www.\+graphicsmagick.\+org}}
\item \href{http://www.ghostscript.com/}{\texttt{ http\+://www.\+ghostscript.\+com/}} 
\end{DoxyItemize}