mono/packages/kbot/ref/utils/signal.ts
2026-04-01 01:05:48 +02:00

44 lines
1.4 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
* Tiny listener-set primitive for pure event signals (no stored state).
*
* Collapses the ~8-line `const listeners = new Set(); function subscribe(){…};
* function notify(){for(const l of listeners) l()}` boilerplate that was
* duplicated ~15× across the codebase into a one-liner.
*
* Distinct from a store (AppState, createStore) — there is no snapshot, no
* getState. Use this when subscribers only need to know "something happened",
* optionally with event args, not "what is the current value".
*
* Usage:
* const changed = createSignal<[SettingSource]>()
* export const subscribe = changed.subscribe
* // later: changed.emit('userSettings')
*/
export type Signal<Args extends unknown[] = []> = {
/** Subscribe a listener. Returns an unsubscribe function. */
subscribe: (listener: (...args: Args) => void) => () => void
/** Call all subscribed listeners with the given arguments. */
emit: (...args: Args) => void
/** Remove all listeners. Useful in dispose/reset paths. */
clear: () => void
}
export function createSignal<Args extends unknown[] = []>(): Signal<Args> {
const listeners = new Set<(...args: Args) => void>()
return {
subscribe(listener) {
listeners.add(listener)
return () => {
listeners.delete(listener)
}
},
emit(...args) {
for (const listener of listeners) listener(...args)
},
clear() {
listeners.clear()
},
}
}