@ 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
}
};
添加新公用事业
在本套件中添加新的公用事业时:
- 在
src/用于工具 - 导出它从
src/index.ts - 添加解释使用情况的 JSDoc 注释
- 以实例更新此 README
- 确保该工具在多个软件包中真正可以重复使用