Class MemoryBroadcaster

constructor

• new MemoryBroadcaster(
      config?: Partial<ConnectionOptions>,
      store?: ConnectionStore,
  ): MemoryBroadcaster

  Parameters

  • config: Partial<ConnectionOptions> = {}

    The connection options.

  • store: ConnectionStore = ...

    The connection store.

  Returns MemoryBroadcaster

Readonlyname

Readonlystore

broadcast

• broadcast<T = unknown>(
      channel: string,
      event: string,
      payload?: T,
  ): Promise<void>

  Type Parameters

  • T = unknown

  Parameters

  • channel: string
  • event: string
  • Optionalpayload: T

  Returns Promise<void>

  Inherit Doc

members

• members(channel: string): Promise<PresenceMember<unknown>[]>

  Parameters

  • channel: string

  Returns Promise<PresenceMember<unknown>[]>

  Inherit Doc

on

• on<T = unknown>(channel: string, listener: RealtimeListener<T>): () => void

  Type Parameters

  • T = unknown

  Parameters

  • channel: string
  • listener: RealtimeListener<T>

  Returns () => void

  Inherit Doc

to

• to(
      channel: string,
  ): { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }

  Parameters

  • channel: string

  Returns { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }

  Inherit Doc

Staticcreate

• create(
      config?: Partial<ConnectionOptions>,
      store?: ConnectionStore,
  ): MemoryBroadcaster

  Create a memory broadcaster.

  Parameters

  • config: Partial<ConnectionOptions> = {}

    The connection options.

  • store: ConnectionStore = ...

    The connection store (defaults to an in-memory one).

  Returns MemoryBroadcaster

  A new broadcaster.