Interface WebStorageOptions<T>

Options for localStorageSignal and sessionStorageSignal.

interface WebStorageOptions<T> {
    debugName?: string;
    equal?: ValueEqualityFn<T>;
    replacer?: ((key: string, value: unknown) => unknown);
    reviver?: ((key: string, value: unknown) => unknown);
}

Type Parameters

  • T

    The type of the value that should be stored and deserialized.

Hierarchy

  • CreateSignalOptions<T>
    • WebStorageOptions

Properties

debugName? equal? replacer? reviver?

Properties

OptionaldebugName

debugName?: string

A debug name for the signal. Used in Angular DevTools to identify the signal.

Optionalequal

equal?: ValueEqualityFn<T>

A comparison function which defines equality for signal values.

Optionalreplacer

replacer?: ((key: string, value: unknown) => unknown)

An optional function to use when serializing a value with JSON.parse.

Optionalreviver

reviver?: ((key: string, value: unknown) => unknown)

An optional function to use when deserializing a value with JSON.parse.

Settings

Member Visibility

On This Page

Properties