Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 1.44 KB

README.md

File metadata and controls

19 lines (12 loc) · 1.44 KB

zen-observable-ts

Thin wrapper around zen-observable and @types/zen-observable, to support ESM exports as well as CommonJS exports, with TypeScript types provided by @types/zen-observable.

Usage

After installing zen-observable-ts using a tool like npm or yarn, you can import the Observable class by name:

import { Observable } from "zen-observable-ts";

Note that this package does not currently have a default export, so the {} braces are mandatory.

Previous versions

This tiny wrapper package replaces an older version of zen-observable-ts that used to provide TypeScript types for zen-observable, before @types/zen-observable was introduced. This version of the package is not intended to be perfectly compatible with the older version, so we have bumped the major version of the package to reflect the difference.

Future plans

As explained in apollographql/apollo-client#7615, the zen-observable-ts package exists to fill a gap in the functionality of the zen-observable package, so we will retire this package in favor of using zen-observable directly, when/if this PR is ever merged.