Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmans/eventery
Super-lightweight event class implementation. 🚀
https://github.com/hmans/eventery
events gamedev javascript pubsub typescript
Last synced: 20 days ago
JSON representation
Super-lightweight event class implementation. 🚀
- Host: GitHub
- URL: https://github.com/hmans/eventery
- Owner: hmans
- License: mit
- Created: 2023-01-08T19:46:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-16T10:01:53.000Z (over 1 year ago)
- Last Synced: 2024-10-05T08:36:10.031Z (about 1 month ago)
- Topics: events, gamedev, javascript, pubsub, typescript
- Language: TypeScript
- Homepage:
- Size: 85.9 KB
- Stars: 19
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Eventery
A tiny publish-subscribe library for JavaScript, specifically tailored for use in games:
- Instantiate event objects with typed arguments.
- Supports events with zero, one, or multiple typed arguments; no need to create extra payload objects for events with multiple arguments.
- Events support synchronous and asynchronous publishing.
- Events provide their own events that notify about new or removed subscribers.
- Zero dependencies!
## Overview
```ts
import { Event } from "eventery";
/* Create an event. You can pass a type to describe the event's
payload arguments. These may optionally be named, like here: */
const event = new Event<[deltaTime: number]>();
/* Create a callback and add it as a subscriber. */
function callback(dt: number) {
console.log(dt);
}
event.subscribe(callback);
/* Publish an event. The subscribers will be invoked synchronously. */
event.publish(123);
/* Unsubscribe the callback. */
event.unsubscribe(callback);
/* Clear all subscribers. */
event.clear();
```
### With React (and similar)
The `subscribe` function returns a function that will unsubscribe the callback when called. This is handy for use with React's `useEffect` hook:
```ts
useEffect(() => event.subscribe(listener), []);
```
## Event Payloads
Event payloads are typed using TypeScript's tuple syntax. For example, the following event has a payload with two arguments:
```ts
const event = new Event<[number, number]>();
```
These arguments may optionally be named:
```ts
const event = new Event<[x: number, y: number]>();
```
Payload arguments can be made optional:
```ts
const event = new Event<[dt: number, context?: string]>();
```
They can use the `...` syntax to indicate that the argument is a rest parameter:
```ts
const event = new Event<[context: string, ...deltas: number[]]>();
```
## Subscribe/Unsubscribe Notification Events
`Event` provides two events that notify about new or removed subscribers:
```ts
import { Event } from "eventery";
const event = new Event<[number]>();
/* Subscribe to the event that notifies about new subscribers. */
event.onSubscribed.subscribe((callback) => {
console.log("New subscriber:", callback);
});
/* Subscribe to the event that notifies about removed subscribers. */
event.onUnsubscribed.subscribe((callback) => {
console.log("Removed subscriber:", callback);
});
const callback = function (dt: number) {
console.log(dt);
};
/* Subscribe a callback. This will trigger all `onSubscribe` callbacks. */
event.subscribe(callback);
/* Unsubscribe the callback. This will trigger all `onUnsubscribe` callbacks. */
event.unsubscribe(callback);
```
## License
```
Copyright (c) 2023 Hendrik Mans
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.
```