Skip to content

getObsidianDevUtilsState<T>

Retrieves or creates a shared-state ValueWrapper for a given key on globalThis.__obsidianDevUtils.

Import:

import { getObsidianDevUtilsState } from 'obsidian-dev-utils/obsidian-dev-utils-state';

Signature:

function getObsidianDevUtilsState(key: string, defaultValue: T): ValueWrapper<T>

Parameters:

ParameterTypeDescription
keystringThe key to store or retrieve the shared state under.
defaultValueTThe default value to use if the shared state does not exist yet.

Returns: ValueWrapper<T> — The ValueWrapper that stores the shared state.