clean-jsdoc-theme TypeDoc APIv0.0.0

Store

Source: index.ts:90

A typed key/value store with a fixed capacity.

Type Parameters

  • T — The value type held by the store.

Constructors

new Store<T>(capacity: number, logger?: Logger): Store<T>

Parameters

  • capacity (number) — Maximum number of entries before Store.set throws.
  • logger (Logger, optional) — Optional logger for diagnostics.

Returns

Store<T>


Properties

capacity: number

readonly
index.ts:103

Maximum number of entries before Store.set throws.

status: Status

Current lifecycle status.

Default: Status.Idle

Accessors

get size(): number

The number of entries currently held.

Methods

get(key: string): T | undefined

Read a value back.

Parameters

  • key (string) — The lookup key.

Returns

  • T | undefined — The stored value, or undefined if absent.

set(key: string, value: T): void

Store a value under key.

Parameters

  • key (string) — The lookup key.
  • value (T) — The value to store.

Returns

  • void

Throws

  • If the store is full or not open.