Class Addon

Base class for Peerix addons.

Index

Constructors

Methods

attach detach emit off on once

Constructors

constructor

new Addon(): Addon
Creates a new Addon instance.

Returns Addon
- Defined in src/addons/addon.ts:13

Methods

attach

attach(room: Room): Promise<void>
Attaches the addon to a Room instance. This method is called when the addon is added using room.attach(addon).
Parameters
- room: Room
  The Room instance to attach to.
Returns Promise<void>
- Defined in src/addons/addon.ts:63

detach

detach(room: Room): Promise<void>
Detaches the addon from a Room instance. This method is called when the addon is removed using room.detach(addon).
Parameters
- room: Room
  The Room instance to detach from.
Returns Promise<void>
- Defined in src/addons/addon.ts:73

emit

emit(event: string, ...args: any[]): void
Emits one or more events from the addon.
Parameters
- event: string
  Event name or list of event names.
- ...args: any[]
  Arguments to pass to the event handlers.
Returns void
- Defined in src/addons/addon.ts:53

off

off(event: string, handler?: (...args: any[]) => void): void
Unsubscribes from one or more events emitted by the addon.
Parameters
- event: string
  Event name or list of event names.
- Optionalhandler: (...args: any[]) => void
  Optional event handler to remove. If not provided, all handlers for the event(s) will be removed.
Returns void
- Defined in src/addons/addon.ts:43

on

on(event: string, handler: (...args: any[]) => void): void
Subscribes to one or more events emitted by the addon.
Parameters
- event: string
  Event name or list of event names.
- handler: (...args: any[]) => void
  Event handler.
Returns void
- Defined in src/addons/addon.ts:23

once

once(event: string, handler: (...args: any[]) => void): void
Subscribes to one or more events emitted by the addon for a single invocation.
Parameters
- event: string
  Event name or list of event names.
- handler: (...args: any[]) => void
  Event handler.
Returns void
- Defined in src/addons/addon.ts:33