better-sse
Advanced tools
Comparing version 0.14.0 to 0.14.1
{ | ||
"name": "better-sse", | ||
"description": "Dead simple, dependency-less, spec-compliant server-sent events implementation for Node, written in TypeScript.", | ||
"version": "0.14.0", | ||
"version": "0.14.1", | ||
"license": "MIT", | ||
"author": "Matthew W. <matthew.widdi@gmail.com>", | ||
"repository": "github:MatthewWid/better-sse", | ||
"homepage": "https://github.com/MatthewWid/better-sse", | ||
"homepage": "https://matthewwid.github.io/better-sse", | ||
"bugs": "https://github.com/MatthewWid/better-sse/issues", | ||
@@ -10,0 +10,0 @@ "keywords": [ |
@@ -33,4 +33,4 @@ # Better SSE | ||
* [Thoroughly tested](./src/Session.test.ts) (+ 100% code coverage!). | ||
* [Comprehensively documented](./docs) with guides and API documentation. | ||
* [Channels](./docs/channels.md) allow you to broadcast events to many clients at once. | ||
* [Comprehensively documented](https://matthewwid.github.io/better-sse) with guides and API documentation. | ||
* [Channels](https://matthewwid.github.io/better-sse/guides/channels) allow you to broadcast events to many clients at once. | ||
* Configurable reconnection time, message serialization and data sanitization (with good defaults). | ||
@@ -40,7 +40,7 @@ * Trust or ignore the client-given last event ID. | ||
* Add or override the response status code and headers. | ||
* Send [individual fields](./docs/api.md#eventbuffer) of events or send [full events with simple helpers](./docs/api.md#sessionpush-data-unknown-eventname-string-eventid-string--this). | ||
* Send [individual fields](https://matthewwid.github.io/better-sse/guides/batching#send-individual-event-fields) of events or send [full events with simple helpers](https://matthewwid.github.io/better-sse/reference/api/#sessionpush-data-unknown-eventname-string-eventid-string--this). | ||
* Pipe [streams](https://nodejs.org/api/stream.html#stream_readable_streams) and [iterables](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators) directly from the server to the client as a series of events. | ||
* Support for popular EventSource polyfills [`event-source-polyfill`](https://www.npmjs.com/package/event-source-polyfill) and [`eventsource-polyfill`](https://www.npmjs.com/package/eventsource-polyfill). | ||
[See a comparison with other Node SSE libraries in the documentation.](./docs/comparison.md) | ||
[See a comparison with other Node SSE libraries in the documentation.](https://matthewwid.github.io/better-sse/reference/comparison) | ||
@@ -66,7 +66,7 @@ # Installation | ||
See the [Recipes](./docs/recipes.md) section of the documentation for use with other frameworks and libraries. | ||
See the [Recipes](https://matthewwid.github.io/better-sse/reference/recipes/) section of the documentation for use with other frameworks and libraries. | ||
--- | ||
Use [sessions](./docs/api.md#session) to push events to clients: | ||
Use [sessions](https://matthewwid.github.io/better-sse/reference/api/#sessionstate) to push events to clients: | ||
@@ -93,3 +93,3 @@ ```typescript | ||
Use [channels](./docs/channels.md) to send events to many clients at once: | ||
Use [channels](https://matthewwid.github.io/better-sse/reference/api/#channelstate-sessionstate) to send events to many clients at once: | ||
@@ -110,3 +110,3 @@ ```typescript | ||
Loop over sync and async [iterables](./docs/api.md#sessioniterate-iterable-iterable--asynciterable-options-object--promisevoid) and send each value as an event: | ||
Loop over sync and async [iterables](https://matthewwid.github.io/better-sse/reference/api/#sessioniterate-iterable-iterable--asynciterable-options-object--promisevoid) and send each value as an event: | ||
@@ -121,3 +121,3 @@ ```typescript | ||
Pipe [readable stream](./docs/api.md#sessionstream-stream-readable-options-object--promiseboolean) data to the client as a stream of events: | ||
Pipe [readable stream](https://matthewwid.github.io/better-sse/reference/api/#sessionstream-stream-readable-options-object--promiseboolean) data to the client as a stream of events: | ||
@@ -134,7 +134,7 @@ ```typescript | ||
Check the [API documentation](./docs/api.md) and [live examples](./examples) for information on getting more fine-tuned control over your data such as managing event IDs, data serialization, event filtering, dispatch controls and more! | ||
Check the [API documentation](https://matthewwid.github.io/better-sse/reference/api) and [live examples](./examples) for information on getting more fine-tuned control over your data such as managing event IDs, data serialization, event filtering, dispatch controls and more! | ||
# Documentation | ||
API documentation, getting started guides and usage with other frameworks is [available on GitHub](./docs). | ||
API documentation, getting started guides and usage with other frameworks is [available on the documentation website](https://matthewwid.github.io/better-sse/). | ||
@@ -141,0 +141,0 @@ # Contributing |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
84680
2