# @a11d/local-storage 中文文档

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

版本：1\.2\.0
npm 元数据更新时间：2026-10-29T14:34:27.189Z
中文译文更新时间：2026-11-06T11:16:31.675Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40a11d/local-storage
原文对照：https://npmcn.com/package/%40a11d/local-storage/?lang=original
项目主页：https://github.com/a11delavar/lit-application/tree/main/packages/LocalStorage
源码仓库：https://github.com/a11delavar/lit-application

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

- 包体积（解压后）：10.7 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@a11d/lit x
- 首次发布：2023-01-26T11:01:45.194Z
- 最新版本发布：2026-10-29T14:34:26.154Z
- 近 30 天下载量：3405（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 3 个）

## 中文简介

一个用于在本地存储中保持打入值的功能,默认为JSON序列化和更改事件.

## 安装

```sh
npm install @a11d/local-storage
```

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

## README

# `@a11d/local-storage`

一个用于在本地存储中保持打入值的功能,默认为JSON序列化和更改事件.

[![npm](https://img.shields.io/npm/v/@a11d/local-storage?style=flat-square&color=0077c8)](https://www.npmjs.com/package/@a11d/local-storage)

## 安装

```sh
npm install @a11d/local-storage
```

## 使用量

### `LocalStorage`

```ts
import { LocalStorage } from '@a11d/local-storage'

const colorScheme = new LocalStorage<'light' | 'dark'>('App.ColorScheme', 'light')

colorScheme.changed.subscribe(value => document.documentElement.style.colorScheme = value)
colorScheme.value = 'dark'
```

### `LocalStorageController`

```ts
import { LocalStorageController } from '@a11d/local-storage'

class ProductList extends Component {
    readonly view = new LocalStorageController<'grid' | 'list'>(this, 'ProductList.View', 'grid')

    protected override get template() {
        return html`<button @click=${() => this.view.value = 'list'}>${this.view.value}</button>`
    }
}
```

## API 密码

| 名称 | 仁爱 | 说明 |
| --- | --- | --- |
| `LocalStorage` | 类 | 在本地存储中以名称保留一个打入的值,返回默认值并宣布每个更改. |
| `LocalStorageController` | 类 | 在本地存储中保留一个输入值, 如 `LocalStorage` 并随时更新其主机. |

## 链接

-   [更改日志](https://unpkg.com/@a11d/local-storage/CHANGELOG.md)
-   [来源](https://github.com/a11delavar/lit-application/tree/main/packages/LocalStorage)

## 许可证

麻省理工学院

## 常见问题

### @a11d/local-storage 是什么？

一个用于在本地存储中保持打入值的功能,默认为JSON序列化和更改事件\.

### 如何安装 @a11d/local-storage？

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

### @a11d/local-storage 支持 TypeScript 吗？

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

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

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

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

@a11d/local-storage 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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