UI kit reference

hooks/keyed-store

import { … } from 'zidane-ui'ui/src/hooks/keyed-store.ts

Functions#

A new empty KeyedStore.

TypeScript

function createKeyedStore<V>(): KeyedStore<V>

Type parameters
Name	Description
V

KeyedStore<V>

The value under key (null when unset or no key), re-rendering only when that key changes.

TypeScript

function useKeyedValue<V>(
  store: KeyedStore<V>,
  key: string | null | undefined,
): V | null

Type parameters
Name	Description
V

Parameters
Name	Type	Description
store	`KeyedStore<V>`	The store to read.
key	`string \| null \| undefined`	The key; `null` / `undefined` reads nothing.

V | null

Values by key, each key with its own subscribers.

TypeScript

interface KeyedStore<V>

KeyedStore type parameters
Name	Description
V

KeyedStore properties
Name	Type	Description
delete	`(key: string) => void`	Forget `key` (a deleted session): its readers see no value.
get	`(key: string) => V \| undefined`	The value under `key`, if any.
set	`(key: string, value: V) => void`	Store `value` under `key` and notify that key's subscribers (nothing when it is the same value).
subscribe	`(key: string, listener: () => void) => () => void`	Call `listener` whenever `key` changes; returns the unsubscribe.