@worker-tools/typed-event-target
Version:
This is the Typed Event Target library you are looking for.
88 lines (68 loc) β’ 4 kB
Markdown
# Typed Event Target
This is the Typed Event Target library you are looking for.
## Usage
```ts
import { TypedEventTarget } from "@worker-tools/typed-event-target";
// Can use custom event maps:
class Foo extends TypedEventTarget<{
"error": ErrorEvent
"custom": CustomEvent<string>
}> {
/* ... */
}
// Enjoy correctly typed event here:
const foo = new Foo()
foo.addEventListener("error", ev => { /* ev: ErrorEvent */ })
foo.addEventListener("custom", ev => { /* ev: CustomEvent<string> */ })
foo.addEventListener("unknown", ev => { /* ev: Event */})
// Can use built-in event maps from e.g. lib.dom.d.ts:
class WorkerLike extends TypedEventTarget<WorkerEventMap> { /* ... */ }
// Can be used as a type:
type WindowLike = TypedEventTarget<WindowEventMap>;
// Uses built-in EventTarget:
foo instanceof EventTarget // => true
// No intermediate classes:
Object.getPrototypeOf(Foo.prototype) === EventTarget.prototype // => true
// Exports helper types in case you need them:
import type {
TypedEventListener,
TypedEventListenerObject,
TypedEventListenerOrEventListenerObject
} from "@worker-tools/typed-event-target"
```
<br/>
--------
<br/>
<p align="center"><a href="https://workers.tools"><img src="https://workers.tools/assets/img/logo.svg" width="100" height="100" /></a>
<p align="center">This module is part of the Worker Tools collection<br/>β
[Worker Tools](https://workers.tools) are a collection of TypeScript libraries for writing web servers in [Worker Runtimes](https://workers.js.org) such as Cloudflare Workers, Deno Deploy and Service Workers in the browser.
If you liked this module, you might also like:
- π§ [__Worker Router__][router] --- Complete routing solution that works across CF Workers, Deno and Service Workers
- π [__Worker Middleware__][middleware] --- A suite of standalone HTTP server-side middleware with TypeScript support
- π [__Worker HTML__][html] --- HTML templating and streaming response library
- π¦ [__Storage Area__][kv-storage] --- Key-value store abstraction across [Cloudflare KV][cloudflare-kv-storage], [Deno][deno-kv-storage] and browsers.
- π [__Response Creators__][response-creators] --- Factory functions for responses with pre-filled status and status text
- π [__Stream Response__][stream-response] --- Use async generators to build streaming responses for SSE, etc...
- π₯ [__JSON Fetch__][json-fetch] --- Drop-in replacements for Fetch API classes with first class support for JSON.
- π¦ [__JSON Stream__][json-stream] --- Streaming JSON parser/stingifier with first class support for web streams.
Worker Tools also includes a number of polyfills that help bridge the gap between Worker Runtimes:
- βοΈ [__HTML Rewriter__][html-rewriter] --- Cloudflare's HTML Rewriter for use in Deno, browsers, etc...
- π [__Location Polyfill__][location-polyfill] --- A `Location` polyfill for Cloudflare Workers.
- π¦ [__Deno Fetch Event Adapter__][deno-fetch-event-adapter] --- Dispatches global `fetch` events using Denoβs native HTTP server.
[router]: https://workers.tools/router
[middleware]: https://workers.tools/middleware
[html]: https://workers.tools/html
[kv-storage]: https://workers.tools/kv-storage
[cloudflare-kv-storage]: https://workers.tools/cloudflare-kv-storage
[deno-kv-storage]: https://workers.tools/deno-kv-storage
[kv-storage-polyfill]: https://workers.tools/kv-storage-polyfill
[response-creators]: https://workers.tools/response-creators
[stream-response]: https://workers.tools/stream-response
[json-fetch]: https://workers.tools/json-fetch
[json-stream]: https://workers.tools/json-stream
[request-cookie-store]: https://workers.tools/request-cookie-store
[extendable-promise]: https://workers.tools/extendable-promise
[html-rewriter]: https://workers.tools/html-rewriter
[location-polyfill]: https://workers.tools/location-polyfill
[deno-fetch-event-adapter]: https://workers.tools/deno-fetch-event-adapter
Fore more visit [workers.tools](https://workers.tools).