rxjs-compat

What is rxjs-compat?

The rxjs-compat package provides backward compatibility for RxJS 5.x codebases when upgrading to RxJS 6.x. It allows developers to use the old import paths and APIs while transitioning to the new version.

What are rxjs-compat's main functionalities?

Backward Compatibility

This feature allows you to use the old RxJS 5.x import paths and operators in your codebase. The code sample demonstrates how to import and use the `map` operator from RxJS 5.x in an RxJS 6.x environment.

import { Observable } from 'rxjs-compat/Observable';
import 'rxjs-compat/add/operator/map';

const observable = Observable.of(1, 2, 3).map(x => x * x);
observable.subscribe(value => console.log(value));

Operator Patching

This feature allows you to patch operators onto the Observable prototype, similar to how it was done in RxJS 5.x. The code sample demonstrates how to use the `filter` operator in an RxJS 6.x environment.

import { Observable } from 'rxjs-compat';
import 'rxjs-compat/add/operator/filter';

const observable = Observable.of(1, 2, 3, 4, 5).filter(x => x % 2 === 0);
observable.subscribe(value => console.log(value));

Static Methods

This feature allows you to use static methods like `of` from RxJS 5.x. The code sample demonstrates how to create an observable using the `of` static method.

import { Observable } from 'rxjs-compat/Observable';

const observable = Observable.of(1, 2, 3);
observable.subscribe(value => console.log(value));

Other packages similar to rxjs-compat

rxjs

RxJS (Reactive Extensions for JavaScript) is a library for reactive programming using Observables, to make it easier to compose asynchronous or callback-based code. RxJS 6.x is the latest version and includes a new modular architecture, improved performance, and better debugging capabilities. Unlike rxjs-compat, it does not provide backward compatibility for RxJS 5.x code.

baconjs

Bacon.js is a functional reactive programming library for JavaScript. It provides similar functionalities to RxJS, such as event streams and property values, but with a different API and approach. Bacon.js focuses on simplicity and ease of use, whereas RxJS offers a more comprehensive set of operators and features.

most

Most.js is a reactive programming library that focuses on high performance and minimalism. It provides a small but powerful set of operators for working with streams. Most.js is designed to be fast and efficient, making it suitable for performance-critical applications. Unlike rxjs-compat, it does not offer backward compatibility for older versions of RxJS.

README

RxJS Compatibility Package

This package is required to get backwards compatibility with RxJS pervious to version 6. It contains the imports to add operators to Observable.prototype and creation methods to Observable. This is what allows, for instance, dot-chaining:

Observable.interval(1)
  .map(i => i * i)

vs

Observable.interval(1)
  .pipe(map(i => i * i))