Class KeyStore

constructor

• new KeyStore(capacity?: number): KeyStore

  Most keys held before the least recently used is evicted.

  Parameters

  • capacity: number = MAX_KEYS

  Returns KeyStore

Readonlycapacity

size

• get size(): number

  Number of keys held.

  Returns number

add

• add(material: KeyMaterial): string

  Store key material and return its new handle.

  Parameters

  • material: KeyMaterial

  Returns string

use

• use(handle: string, kinds: readonly KeyKind[]): KeyMaterial

  Look up a key for use by a tool that accepts the given kinds. Using a key marks it most recently used.

  Parameters

  • handle: string
  • kinds: readonly KeyKind[]

  Returns KeyMaterial

describe

• describe(handle: string): Record<string, unknown>

  Public description of one key: handle, type and metadata.

  Parameters

  • handle: string

  Returns Record<string, unknown>

list

• list(): Record<string, unknown>[]

  Public descriptions of every key, least recently used first.

  Returns Record<string, unknown>[]

remove

• remove(handle: string): boolean

  Wipe and forget one key. Returns false if the handle is unknown.

  Parameters

  • handle: string

  Returns boolean