Skip to content
On this page

Home > @taiyuuki/utils > storage_get

storage_get() function

该函数从本地存储中检索数据并将其作为已解析的 JSON 对象或可选的默认值返回。

Signature:

typescript
declare function storage_get<T, K extends T = T>(key: string, empty?: K): T | undefined;
declare function storage_get<T, K extends T = T>(key: string, empty?: K): T | undefined;

Parameters

ParameterTypeDescription
keystring键是一个字符串,用于标识存储在 localStorage 中的数据。它用于在需要时检索数据。
emptyK(Optional) 该参数是可选的,表示如果在 localStorage 中找不到指定键的值,则返回默认值。如果未提供“empty”,则如果找不到该值,该函数将返回“undefined”。

Returns:

T | undefined

函数 storage_get 返回类型为 Tundefined 的值。返回值的类型取决于 empty 参数的类型,该参数是可选的,默认值为 undefined。如果未提供“empty”或为“undefined”,则该函数返回类型为“T”或“undefined”的值。如果提供了empty并且 该值为“undefined”,则该函数返回“undefined”。

Released under the MIT License.