@grest-ts/common

中文文档
0.0.101发布于 2026/11/02MITTypeScriptES Module近 30 天下载 7738

所有GG软件包共用的通用功能和类型

中文使用文档
文档目录7 节
  1. 目的
  2. 公用事业
  3. deepFreeze<T>(obj: T): T
  4. withTimeout<T>(promise: Promise<T>, timeoutMs: number, erro…
  5. 类型
  6. DeepPartial<T>
  7. 添加新公用事业

部分 灰尘 框架. 文档 | 所有软件包

@ grest- ts/ 常见

所有GG软件包共享的通用功能和类型.

目的

这个软件包包含了在Grest框架中跨多个软件包使用的功能和类型. 通过将它们合并到这里,我们:

  • 消除代码重复
  • 确保各套件的一致性
  • 方便维护
  • 减少软件包依赖性

公用事业

deepFreeze<T>(obj: T): T

递解地将一个物体及其所有被嵌入的属性冻结,使其不可改变.

import { deepFreeze } from '@grest-ts/common';

const config = deepFreeze({
  name: 'app',
  settings: {
    debug: true
  }
});

// This will throw an error in strict mode
config.settings.debug = false;

withTimeout<T>(promise: Promise<T>, timeoutMs: number, errorMessage: string): Promise<T>

{\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}我答应你暂停 如果承诺没有在指定的超时范围内解决/拒绝,返回的承诺会以出错的方式拒绝.

import { withTimeout } from '@grest-ts/common';

const result = await withTimeout(
  fetch('https://api.example.com'),
  5000,
  'API request timed out'
);

类型

DeepPartial<T>

递归使对象的所有属性具有可选性. 在测试和验证中用于部分匹配.

import { DeepPartial } from '@grest-ts/common';

interface User {
  id: string;
  profile: {
    name: string;
    email: string;
  };
}

// All properties are optional
const partialUser: DeepPartial<User> = {
  profile: {
    name: 'Alice'
    // email is optional
  }
};

添加新公用事业

在本套件中添加新的公用事业时:

  1. 在 src/ 用于工具
  2. 导出它从 src/index.ts
  3. 添加解释使用情况的 JSDoc 注释
  4. 以实例更新此 README
  5. 确保该工具在多个软件包中真正可以重复使用

版本与发布记录

@grest-ts/common 共发布 84 个版本,首次发布于 2026/02/24;过去 12 个月发布了 84 个版本。

版本发布日期距今
0.0.101latest2026/11/0214 天前
0.0.1002026/10/3017 天前
0.0.992026/10/3018 天前
0.0.982026/10/2820 天前
0.0.972026/10/2720 天前
0.0.962026/10/2721 天前

关于 @grest-ts/common 的常见问题

@grest-ts/common 是什么?

所有GG软件包共用的通用功能和类型

如何安装 @grest-ts/common?

在项目目录运行 npm install @grest-ts/common,或使用 pnpm add / yarn add / bun add。

@grest-ts/common 支持 TypeScript 吗?

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

@grest-ts/common 支持 ESM 还是 CommonJS?

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

@grest-ts/common 需要什么版本的 Node.js?

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

@grest-ts/common 可以商用吗?

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

@grest-ts/common 的下载量有多少?

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

@grest-ts/common 还在维护吗?

最新版本 0.0.101 发布于 2026/11/02(14 天前);至今共发布 84 个版本,其中过去 12 个月发布了 84 个;首次发布于 2026/02/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。