# @jack-barr3tt/bouncer-client 中文文档

规范地址：https://npmcn.com/package/%40jack-barr3tt/bouncer-client/

版本：0\.5\.1
npm 元数据更新时间：2026-11-01T12:37:42.295Z
中文译文更新时间：2026-11-01T12:49:46.150Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：11.5 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-04T10:39:30.827Z
- 最新版本发布：2026-11-01T12:37:42.182Z
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

由Bouncer服务的应用的身份、访问和每个应用的存储。

## 安装

```sh
npm install @jack-barr3tt/bouncer-client
```

也可以使用：`pnpm add @jack-barr3tt/bouncer-client`、`yarn add @jack-barr3tt/bouncer-client`、`bun add @jack-barr3tt/bouncer-client`

## README

# @jack-barr3tt / bouncer-client

所服务的应用的身份和每个应用的存储空间 [保镖](https://github.com/jack-barr3tt/bouncer).

```bash
npm install @jack-barr3tt/bouncer-client
```

```ts
import { Bouncer } from '@jack-barr3tt/bouncer-client'

const bouncer = new Bouncer('your-slug')
const who = await bouncer.identity()
// { kind: 'user', username } or { kind: 'temporary', nickname }

bouncer.watch()

await bouncer.storage.setItem('theme', 'dark')
const theme = await bouncer.storage.getItem('theme')
```

`identity()` 读取 `/api/session` 并返回已登录的用户名或昵称，或 `null` 当没有人签到时。

`watch()` 监听 `/api/access/stream`． 当对该应用程序的访问被删除时，它将浏览器发送到主页，并在会话结束时发送到登录页面。

`storage` 是这个人的app的localStorage。 `getItem`， `setItem`， `removeItem`， `clear`， `key`, `length` 每个返回一个承诺。值是字符串。该库加载并保存文档，并在其他浏览器保存时重试。 `getItem` 返回 `null` 当没有人签到时。 `length()` 是一个方法，因为它必须读取文档。一笔可以通过的信 `STORAGE_MAX_BYTES` （1 MiB，除非部署设置它）拒绝with `QuotaExceededError`.

当您开发时，代理 `/api` 保镖。Vite开发服务器不在大门后面。

## 许可证

[麻省理工学院](https://npmcn.com/package/%40jack-barr3tt/bouncer-client/LICENSE)

## 常见问题

### @jack-barr3tt/bouncer-client 是什么？

由Bouncer服务的应用的身份、访问和每个应用的存储。

### 如何安装 @jack-barr3tt/bouncer-client？

在项目目录运行 npm install @jack-barr3tt/bouncer-client，或使用 pnpm add / yarn add / bun add。

### @jack-barr3tt/bouncer-client 支持 TypeScript 吗？

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

### @jack-barr3tt/bouncer-client 支持 ESM 还是 CommonJS？

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

### @jack-barr3tt/bouncer-client 可以商用吗？

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

### @jack-barr3tt/bouncer-client 还在维护吗？

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