@tsed/sse
Version:
Server-sent events package for Ts.ED framework
180 lines (130 loc) • 6.54 kB
Markdown
<p style="text-align: center" align="center">
<a href="https://tsed.dev" target="_blank"><img src="https://tsed.dev/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
</p>
<div align="center">
<h1>Server-sent events</h1>
[](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
[](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
[](https://badge.fury.io/js/%40tsed%2Fcommon)
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/prettier/prettier)
[](https://github.com/sponsors/romakita)
[](https://opencollective.com/tsed)
</div>
<div align="center">
<a href="https://tsed.dev/">Website</a>
<span> • </span>
<a href="https://tsed.dev/getting-started/">Getting started</a>
<span> • </span>
<a href="https://slack.tsed.dev">Slack</a>
<span> • </span>
<a href="https://twitter.com/TsED_io">Twitter</a>
</div>
<hr />
A package of Ts.ED framework. See website: https://tsed.dev/tutorials/server-sent-events
Server-sent events let you push data to the client. It's a simple way to send data from the server to the client. The data is sent as a stream of messages, with an optional event name and id. It's a simple way to send data from the server to the client.
## Installation
Before using the Server-sent events, we need to install the `/sse` module.
```bash
npm install --save /sse
```
Then add the following configuration in your Server:
```typescript
import {Configuration} from "@tsed/di";
import "@tsed/sse"; // import sse Ts.ED module
export class Server {}
```
::: warning
There is a known issue with the `compression` middleware. The
`compression` middleware should be disabled to work correctly with Server-sent events.
:::
## Features
- Support decorator usage to enable event-stream on an endpoint,
- Support Node.js stream like `EventEmmiter` to emit events from your controller to your consumer,
- Support `Observable` from `rxjs` to emit events from your controller to your consumer.
- Support `/json-mapper` to serialize your model before sending it to the client.
- Gives an API compatible with Express.js and Koa.js.
## Enable event-stream
To enable the event-stream on an endpoint, you need to use the `` decorator on a method of a controller.
```typescript
import {Controller} from "@tsed/di";
import {Get} from "@tsed/schema";
import {EventStream, EventStreamCtx} from "@tsed/sse";
export class MyCtrl {
events( eventStream: EventStreamCtx) {
let intervalId: ReturnType<typeof setInterval>;
eventStream.on("close", () => {
clearInterval(intervalId);
});
eventStream.on("end", () => {
clearInterval(intervalId);
});
intervalId = setInterval(() => {
// Ts.ED support Model serialization using json-mapper here
eventStream.emit("event", new Date());
}, 1000);
}
}
```
### Stream events
You can use Node.js stream like `EventEmmiter` to emit events from your controller to your consumer:
```ts
import {EventStream} from "@tsed/sse";
import {Controller} from "@tsed/di";
import {Get} from "@tsed/schema";
export class MyCtrl {
private eventEmitter = new EventEmitter();
$onInit() {
setInterval(() => {
this.eventEmitter.emit("message", new Date());
}, 1000);
}
events() {
return this.eventEmitter;
}
}
```
### Observable
You can also use `Observable` from `rxjs` to emit events from your controller to your consumer:
```ts
import {EventStream} from "@tsed/sse";
import {Controller} from "@tsed/di";
import {Get} from "@tsed/schema";
export class MyCtrl {
events() {
const observable = new Observable((observer) => {
setInterval(() => {
observer.next(new Date());
}, 1000);
});
return observable;
}
}
```
## Documentation
See our documentation https://tsed.dev/api.html
## Contributors
<a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
## License
The MIT License (MIT)
Copyright (c) 2016 - today Romain Lenzotti
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.