| 1 | # zen-observable-ts
|
| 2 |
|
| 3 | Thin wrapper around [`zen-observable`](https://www.npmjs.com/package/zen-observable) and [`@types/zen-observable`](https://www.npmjs.com/package/@types/zen-observable), to support ESM exports as well as CommonJS exports, with TypeScript types provided by `@types/zen-observable`.
|
| 4 |
|
| 5 | ## Usage
|
| 6 |
|
| 7 | After installing `zen-observable-ts` using a tool like [npm](https://www.npmjs.com/package/npm) or [yarn](https://yarnpkg.com/), you can import the `Observable` class by name:
|
| 8 | ```js
|
| 9 | import { Observable } from "zen-observable-ts";
|
| 10 | ```
|
| 11 | Note that this package does not currently have a default export, so the `{}` braces are mandatory.
|
| 12 |
|
| 13 | ## Previous versions
|
| 14 |
|
| 15 | This tiny wrapper package replaces [an older version of `zen-observable-ts`](https://github.com/apollographql/apollo-link/tree/master/packages/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.
|
| 16 |
|
| 17 | ## Future plans
|
| 18 |
|
| 19 | As explained in https://github.com/apollographql/apollo-client/pull/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](https://github.com/zenparsing/zen-observable/pull/74) is ever merged.
|