@grest-ts/common

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

Common utility functions and types shared across all GG packages

原始使用文档
文档目录7 节
  1. Purpose
  2. Utilities
  3. deepFreeze<T>(obj: T): T
  4. withTimeout<T>(promise: Promise<T>, timeoutMs: number, erro…
  5. Types
  6. DeepPartial<T>
  7. Adding New Utilities

Part of the grest-ts framework. Documentation | All packages

@grest-ts/common

Common utility functions and types shared across all GG packages.

Purpose

This package contains utility functions and types that are used across multiple packages in the Grest framework. By consolidating them here, we:

  • Eliminate code duplication
  • Ensure consistency across packages
  • Make maintenance easier
  • Reduce package dependencies

Utilities

deepFreeze<T>(obj: T): T

Recursively freezes an object and all its nested properties, making it immutable.

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>

Wraps a promise with a timeout. If the promise doesn't resolve/reject within the specified timeout, the returned promise will reject with an error.

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

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

Types

DeepPartial<T>

Recursively makes all properties of an object optional. Useful for partial matching in tests and validation.

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
  }
};

Adding New Utilities

When adding new utilities to this package:

  1. Create a new file in src/ for the utility
  2. Export it from src/index.ts
  3. Add JSDoc comments explaining usage
  4. Update this README with examples
  5. Ensure the utility is truly reusable across multiple packages

版本与发布记录

@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 是什么?

Common utility functions and types shared across all GG packages

如何安装 @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 和提交记录判断。