PubSub

v0.0.2tested

Simple PubSub implementation

Signature

class PubSub<Events extends Record<string, (...args: any[]) => any>>

Eventsextends Record<string, (...args: any[]) => any>

on

Subscribe to an event

public on<K extends keyof Events>(event: K, listener: Events[K])

Parameter	Type	Default	Description
`event`	`K`	—	Name of the event
`listener`	`Events[K]`	—	Listener function

Returnsthis

off

Unsubscribe from an event

public off<K extends keyof Events>(event: K, listener: Events[K])

Parameter	Type	Default	Description
`event`	`K`	—	Name of the event
`listener`	`Events[K]`	—	Listener function

Returnsthis

once

Subscribe to an event only once

public once<K extends keyof Events>(event: K, listener: Events[K])

Parameter	Type	Default	Description
`event`	`K`	—	Name of the event
`listener`	`Events[K]`	—	Listener function

Returnsthis

emit

Emit an event

public emit<K extends keyof Events>(event: K, ...args: Parameters<Events[K]>)

Parameter	Type	Default	Description
`event`	`K`	—	Name of the event
`args`?	`Parameters<Events[K]>`	—	Arguments for the listener

Returnsboolean

clear

Clear all listeners for an event

public clear<K extends keyof Events>(event: K)

Parameter	Type	Default	Description
`event`	`K`	—	Name of the event

Returnsthis