Skip to content

Commit

Permalink
support spec 0.9.0
Browse files Browse the repository at this point in the history
We were already spec-compliant before because
we were already handling missing performer data
since long ago.
  • Loading branch information
ChlodAlejandro committed Jun 27, 2024
1 parent 5b4cf95 commit 3545786
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@ wikimedia-streams connects to Wikimedia's [Event Platform EventStreams](https://

This package works best with TypeScript, but also works with plain JavaScript.

By default, this package requires an [`EventEmitter`](https://nodejs.org/docs/latest/api/events.html#class-eventemitter) polyfill when used on a browser. Special output files with a bundled EventEmitter polyfill for userscripts and gadgets are available; see below for more information. Really old browser may also need an [`EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) polyfill; this must be loaded separately, as this package doesn't provide a version bundled with such a polyfill. On Node.js, native `EventEmitter` is used, and [eventsource](https://www.npmjs.com/package/eventsource) is used as an EventSource polyfill. This dependency structure allows the package to have the same signature in the browser and in Node.
By default, this package requires an [`EventEmitter`](https://nodejs.org/docs/latest/api/events.html#class-eventemitter) polyfill when used on a browser. Special output files with a bundled EventEmitter polyfill for userscripts and gadgets are available; see below for more information. Really old browser may also need an [`EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) polyfill; this must be loaded separately, as this package doesn't provide a version bundled with such a polyfill. On Node.js, native `EventEmitter` is used, and [eventsource](https://www.npmjs.com/package/eventsource) is used as an EventSource polyfill. This dependency structure allows the package to have the same signature in the browser and in Node.

This package always supports the latest version of the spec. Minor version bumps on the spec count as breaking changes on this package. Refer to the following table for spec versions supported by each version.

| Package version | [Spec version](https://stream.wikimedia.org/?spec) |
|-----------------------|----------------------------------------------------|
| `2.0.0`–`3.0.0` | `0.8.0`, `0.9.0` |
| `0.1.0`–`2.0.0` | `0.7.3` |

## Setup

Expand Down
2 changes: 1 addition & 1 deletion spec.json

Large diffs are not rendered by default.

0 comments on commit 3545786

Please sign in to comment.