README.md

observable-to-async-generator

Convert an observable to ES6 async generator.

Why observable-to-async-generator?

• it has no dependencies;
• it is always 100% covered with unit tests;
• it is written in TypeScript;
• it can be extended with a PR;

Import

import otag from "observable-to-async-generator";

… or:

const otag = require("observable-to-async-generator").default;

Usage

try {
	for await (const item of otag(observable)) {
		doSomethingWith(item);
	}
} catch (error) {
	handle(error);
}

Notes

• rxjs is a peer dependency for this package; it is primarily used to add types on the development stage. These type imports are then removed from the JavaScript output, but are still present in *.d.ts files. In case if the type information is needed to you (for example, if your package/application is also written in TypeScript), you should install rxjs manually; inspect the peerDependencies object inside of observable-to-async-generator's package.json file to find the appropriate version of rxjs to install.