# @esposter/shared 中文文档

规范地址：https://npmcn.com/package/%40esposter/shared/

版本：4\.10\.1
npm 元数据更新时间：2026-11-13T21:49:25.470Z
中文译文更新时间：2026-11-13T22:40:20.960Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40esposter/shared
原文对照：https://npmcn.com/package/%40esposter/shared/?lang=original
项目主页：https://github.com/Esposter/Esposter/blob/main/packages/shared#readme
源码仓库：https://github.com/Esposter/Esposter

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

- 包体积（解压后）：295 kB，486 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：zod ^4\.6\.7
- 首次发布：2024-05-18T02:55:27.564Z
- 最新版本发布：2026-11-13T21:49:25.099Z
- 近 30 天下载量：3923（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：138（近 12 个月 54 个）

## 中文简介

一个包含共享打字码的库.

## 安装

```sh
npm install @esposter/shared
```

也可以使用：`pnpm add @esposter/shared`、`yarn add @esposter/shared`、`bun add @esposter/shared`

## README

# @ 贴出/ 共享

[![Apache-2.0 licensed](https://img.shields.io/github/license/Esposter/Esposter.svg?color=blue)](https://github.com/Esposter/Esposter/blob/main/LICENSE) [![NPM version](https://img.shields.io/npm/v/@esposter/shared/latest?color=brightgreen)](https://www.npmjs.com/package/@esposter/shared/v/latest) [![NPM downloads](https://img.shields.io/npm/dm/@esposter/shared.svg)](https://www.npmjs.com/package/@esposter/shared/v/latest) [![NPM Unpacked Size (with version)](https://img.shields.io/npm/unpacked-size/@esposter/shared/latest?label=npm)](https://www.npmjs.com/package/@esposter/shared/v/latest)

为 Esposter 平台提供共享的TypeScript 工具,类型和出错类别.

设计笔记在现场 [规格](https://github.com/Esposter/Esposter/tree/main/openspec/specs/shared)。 。 。 .

## 目录

-   🚀 [开始](https://npmcn.com/package/%40esposter/shared/#readme-getting-started)
-   🧩 [密钥导出](https://npmcn.com/package/%40esposter/shared/#readme-key-exports)
-   ⚖️ [许可证](https://npmcn.com/package/%40esposter/shared/#readme-license)

* * *

## 开始

安装软件包和 Zod .

```bash
pnpm i @esposter/shared zod
```

该软件包在浏览器和服务器环境中工作.

## QQ 密钥导出

#### 错误分类

```ts
import { InvalidOperationError, NotFoundError, ForbiddenError, NotInitializedError } from "@esposter/shared";

throw new InvalidOperationError(Operation.Read, file.name, zodError.message);
```

#### 阵列公用事业

```ts
import { takeOne } from "@esposter/shared";

// The first item, typed without `undefined`; an out-of-bounds index still yields `undefined` at runtime
const first = takeOne(items);
```

#### 类型公用事业

```ts
import type { ToData, DeepOmit, GetPaths } from "@esposter/shared";

// ToData<T> — the plain data shape of T, with its `toJSON` method removed at every depth
type RawColumn = ToData<Column>;
```

#### 反应

```ts
import { toRawDeep, getRawData } from "@esposter/shared";

// Recursively unwrap Vue reactive proxies
const raw = toRawDeep(reactiveObject);
```

#### 文本 / 字符串

```ts
import { capitalize, truncate, toKebabCase } from "@esposter/shared";
```

#### 错误处理( 反应模式)

```ts
import { getResult, getResultAsync, withFinalizer } from "@esposter/shared";
```

## 许可证

本项目根据以下规定获得许可证: [Apache-2.0 许可证](https://github.com/Esposter/Esposter/blob/main/LICENSE)。 。 。 .

## 常见问题

### @esposter/shared 是什么？

一个包含共享打字码的库\.

### 如何安装 @esposter/shared？

在项目目录运行 npm install @esposter/shared，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.6\.7）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @esposter/shared 支持 TypeScript 吗？

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

### @esposter/shared 支持 ESM 还是 CommonJS？

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

### @esposter/shared 可以商用吗？

@esposter/shared 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @esposter/shared 的下载量有多少？

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

### @esposter/shared 还在维护吗？

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