Class Addon

Base class for Peerix addons.

Addons are modular extensions that can be attached to a Peer instance to provide additional functionality or integrate with external services.

Index

Constructors

Methods

attach detach emit off on once

Constructors

constructor

new Addon(): Addon
Returns Addon
- Defined in src/addons/addon.ts:16

Methods

attach

attach(peer: Peer): Promise<void>
Attach the addon to a Peer instance. This method is called when the addon is added to a peer using peer.attach(addon).
Parameters
- peer: Peer
  The Peer instance to attach to.
Returns Promise<void>
- Defined in src/addons/addon.ts:26

detach

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

emit

emit<K extends string | number>(event: K | K[], ...args: AddonEvents[K]): void
Emit one or more events from the addon.
Type Parameters
- K extends string | number
Parameters
- event: K | K[]
  Event name or list of event names.
- ...args: AddonEvents[K]
  Arguments to pass to the event handlers.
Returns void
- Defined in src/addons/addon.ts:76

off

off<K extends string | number>(
event: K | K[],
handler?: (...args: AddonEvents[K]) => void,
): void
Unsubscribe from one or more events emitted by the addon.
Type Parameters
- K extends string | number
Parameters
- event: K | K[]
  Event name or list of event names.
- Optionalhandler: (...args: AddonEvents[K]) => 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:66

on

on<K extends string | number>(
event: K | K[],
handler: (...args: AddonEvents[K]) => void,
): void
Subscribe to one or more events emitted by the addon.
Type Parameters
- K extends string | number
Parameters
- event: K | K[]
  Event name or list of event names.
- handler: (...args: AddonEvents[K]) => void
  Event handler.
Returns void
- Defined in src/addons/addon.ts:46

once

once<K extends string | number>(
event: K | K[],
handler: (...args: AddonEvents[K]) => void,
): void
Subscribe to one or more events emitted by the addon for a single invocation.
Type Parameters
- K extends string | number
Parameters
- event: K | K[]
  Event name or list of event names.
- handler: (...args: AddonEvents[K]) => void
  Event handler.
Returns void
- Defined in src/addons/addon.ts:56