# @electrovir/local-storage-client 中文文档

规范地址：https://npmcn.com/package/%40electrovir/local-storage-client/

版本：0\.1\.1
npm 元数据更新时间：2026-07-29T14:33:55.463Z
中文译文更新时间：2026-11-13T12:08:39.419Z
软件包许可：\(MIT OR CC0-1\.0\)

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40electrovir/local-storage-client
原文对照：https://npmcn.com/package/%40electrovir/local-storage-client/?lang=original
项目主页：https://github.com/electrovir/local-storage-client
源码仓库：https://github.com/electrovir/local-storage-client

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：23.9 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- peer 依赖：object-shape-tester \>=6
- 首次发布：2026-01-05T15:08:46.087Z
- 最新版本发布：2026-07-29T14:33:55.281Z
- 近 30 天下载量：5569（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

一个将JSON值存储到具有类型安全的本地Storage API的接口.

## 安装

```sh
npm install @electrovir/local-storage-client
```

也可以使用：`pnpm add @electrovir/local-storage-client`、`yarn add @electrovir/local-storage-client`、`bun add @electrovir/local-storage-client`

## README

# @electrovir/ local- storage- 客户端

用于将值存储到具有类型安全的本地Storage API 的接口 。 注意只有JSON兼容数据可以存储.

请注意,一些浏览器积极地清除了本地Storage,因此这只应用于电子数据存储。 如果您需要更永久的存储, 请使用 [本地客户](https://www.npmjs.com/package/local-db-client) 换句话说.

参考文件: [https://electrovir.github.io/ 本地存储-客户端](https://electrovir.github.io/local-storage-client)

## 内部

```sh
npm i @electrovir/local-storage-client
```

## 使用量

```TypeScript
import {defineShape} from 'object-shape-tester';
import {LocalStorageClient} from '@electrovir/local-storage-client';

const myClient = new LocalStorageClient({
    stringValue: defineShape(''),
    numberValue: defineShape(-1),
    booleanValue: defineShape(false),
    objectValue: defineShape({
        name: '',
        age: 0,
        location: '',
    }),
});

/** Set values with type safety. */
myClient.set.objectValue({
    age: 10,
    location: 'Earth',
    name: 'Example User',
});
myClient.set.booleanValue(true);

/** Delete a stored value. */
myClient.delete.booleanValue();

/** Get a stored value. If the stored value is not valid, `undefined` is returned. */
myClient.get.objectValue();
```

## 常见问题

### @electrovir/local-storage-client 是什么？

一个将JSON值存储到具有类型安全的本地Storage API的接口\.

### 如何安装 @electrovir/local-storage-client？

在项目目录运行 npm install @electrovir/local-storage-client，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：object-shape-tester（\>=6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @electrovir/local-storage-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @electrovir/local-storage-client 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @electrovir/local-storage-client 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @electrovir/local-storage-client 可以商用吗？

@electrovir/local-storage-client 使用 \(MIT OR CC0-1\.0\) 许可。可在 MIT、CC0-1\.0 中任选其一遵守。选择 MIT 时，宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @electrovir/local-storage-client 的下载量有多少？

根据 npm 官方下载统计，@electrovir/local-storage-client 在 2026/10/14 – 2026/11/12 这 30 天内被下载 5,569 次，日均约 186 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @electrovir/local-storage-client 还在维护吗？

最新版本 0\.1\.1 发布于 2026/07/29（3 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 5 个；首次发布于 2026/01/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。