[]previous and next page

MemoryAdapterOptions

Options of memoryAdapter.

Options of memoryAdapter.

Import#

ts
import type { MemoryAdapterOptions } from "@shadow-js/realtime/server";

Signature#

ts
interface MemoryAdapterOptions {
  /** The clock, in epoch milliseconds. Default: `Date.now`. */
  readonly now?: () => number;
  /**
   * Milliseconds a channel with no listener and no retained message is remembered. After that its head is forgotten and its
   * numbering restarts, which a resuming client sees as `reset`. Default: one hour.
   */
  readonly idleMs?: number;
  /**
   * Receives a listener's failure (a message or presence listener that threw). Delivery to the other listeners goes on either
   * way. `createHub` passes its own `onError` here. Default: `console.error`, so a bug in a listener is never silent.
   */
  readonly onError?: (error: unknown, context: MemoryErrorContext) => void;
}

Members#

Name Type Description
now? readonly now?: () => number The clock, in epoch milliseconds. Default: Date.now.
idleMs? readonly idleMs?: number Milliseconds a channel with no listener and no retained message is remembered. After that its head is forgotten and its numbering restarts, which a resuming client sees as reset. Default: one hour.
onError? readonly onError?: (error: unknown, context: MemoryErrorContext) => void Receives a listener's failure (a message or presence listener that threw). Delivery to the other listeners goes on either way. createHub passes its own onError here. Default: console.error, so a bug in a listener is never silent.