# @gilbarbara/helpers 中文文档

规范地址：https://npmcn.com/package/%40gilbarbara/helpers/

版本：0\.9\.5
npm 元数据更新时间：2025-01-06T01:05:06.245Z
中文译文更新时间：2026-11-16T08:59:41.792Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：295 kB，23 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2021-04-23T12:43:25.334Z
- 最新版本发布：2025-01-06T01:05:06.049Z
- 近 30 天下载量：114863（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 0 个）

## 中文简介

收集有用的职能

## 安装

```sh
npm install @gilbarbara/helpers
```

也可以使用：`pnpm add @gilbarbara/helpers`、`yarn add @gilbarbara/helpers`、`bun add @gilbarbara/helpers`

## README

# @gilbarbara/ 帮助者

[![npm version](https://badge.fury.io/js/%40gilbarbara%2Fhelpers.svg)](https://badge.fury.io/js/%40gilbarbara%2Fhelpers) [![CI](https://github.com/gilbarbara/helpers/actions/workflows/main.yml/badge.svg)](https://github.com/gilbarbara/helpers/actions/workflows/main.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gilbarbara_helpers&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gilbarbara_helpers)

收集有用的职能

## 使用量

```shell
npm i @gilbarbara/helpers
```

```typescript
import { unique } from '@gilbarbara/helpers';

const password = unique(24, { includeSymbols: true });
console.log(password); // g9HBfQeeOgrP.V1?JhETxn9P
```

## API 密码

### 阵列

**创建Array( 大小: 数字, 起始数: 数字 = 1): 数字 \[\]**  
创建一个顺序数组.

**获得Random 项目<T>(输入:T\[\]):T**  
从数组中获取随机项目 .

**快速 Sort <T 扩展字符串QQ数字>(输入:T\[\]):T\[\]**  
使用快速排序算法排序数组.

**shuffle <T=未知 > (输入:T\[\]):T\[\]**  
使用 Fisher-Yates 算法打乱一个阵列 .

**排序 LlocaleCompare(键 ?: 字符串, 选项 ?): intl。 整理选项 & {正在下降? : boolean} : 排序功能**  
以本地比较比较返回排序函数 .

类型定义

```typescript
interface SortFunction<T = string> {
  (left: PlainObject, right: PlainObject): number;
  (left: T, right: T): number;
}
```
示例

```typescript
// with an array of strings
const strings = ['Mãe', 'limão', 'cachê', 'tião', 'amô', 'côncavo'];
strings.sort(sortByLocaleCompare());
// [ 'amô', 'cachê', 'côncavo', 'limão', 'Mãe', 'tião' ]

// with an array of objects
const objects = [{ key: 'réservé' }, { key: 'Premier' }, { key: 'Cliché' }, { key: 'communiqué' }, { key: 'café' }, { key: 'Adieu' }];
objects.sort(sortByLocaleCompare('key', { descending: true }));
/*
[
{ key: 'réservé' },
{ key: 'Premier' },
{ key: 'communiqué' },
{ key: 'Cliché' },
{ key: 'café' },
{ key: 'Adieu' }
]
*/
```

**排序 ByPrimitive <T extend number QQ boolean > (键? : 字符串, 正在下降? : boolean = false): 排序功能**  
返回具有原始值比较的排序函数.

类型定义

```typescript
interface SortFunction<T = string> {
  (left: PlainObject, right: PlainObject): number;
  (left: T, right: T): number;
}
```
示例

```typescript
const objects = [{ cycle: 3, status: true }, { cycle: 1, status: false }, { cycle: 3, status: true }, { cycle: 4, status: false }];
objects.sort(sortByPrimitive('status', true));
/*
[
{ cycle: 3, status: true },
{ cycle: 3, status: true },
{ cycle: 1, status: false },
{ cycle: 4, status: false }
]
*/
```

**排序算法( 左: 字符串 QQ 数字, 右: 字符串 QQ 数字): 数字**  
基本类比较.

**分拆 IntoChunks <T>(阵列:T\[\],块大小:数字=25):T\[\]\[\]**  
将数组分割成块 .

### 自动同步

**ASYNC 统计**  
带有可能的同步状态的常数 .

**cors( 数据: 任意, 状态CodeOr options: number QQ Cors Options = 200): CorsResponse**  
返回 CORS 响应.

类型定义

```typescript
type HttpMethods = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';

interface CorsOptions {
  /** @default true */
  allowCredentials?: boolean;
  /** @default [] */
  allowedHeaders?: string[];
  /** @default ['GET'] */
  methods?: HttpMethods[];
  /** @default * */
  origin?: string;
  responseHeaders?: Record<string, string>;
  /** @default 200 */
  statusCode?: number;
}

interface CorsResponse {
  body: string;
  headers: Record<string, string>;
  statusCode: number;
}
```

**民意调查(条件 :( ) @ @ @ boolean, 选项? : 选项 : 保证< 无效>**  
等待根据选项实现条件真实性.

类型定义

```typescript
interface PollOptions {
  delay?: number; // 1 (seconds)
  maxRetries?: number; // 5 (seconds)
}
```

**请求<D=任何>(url: string, options?):承诺<D>**  
执行同步请求 .

类型定义

```typescript
type HttpMethods = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';

interface RequestOptions {
  body?: any;
  headers?: PlainObject;
  method?: HttpMethods;
}
```

> 如果您的节点版本不支持获取, 您需要多填充 .

**睡眠( 秒 : 数 = 1 ) : 保证 < void >**  
屏蔽 Aync 执行 X 秒 .

### 日期

**是IsoDate( 输入 : 字符串):布尔**  
检查输入是否为 ISO 日期 .

**isoDate( 输入 ? : string QQ 数字): 字符串**  
返回一个 ISO 日期.

**是ValidDate( 输入: 字符串 QQ数字 QQ 日期):布尔**  
检查输入是否为有效日期 .

**现在( ): 编号**  
返回一个unix时间戳(自1970-01-01 00:00 UTC起为秒).

**时间( 输入: 日期 QQ 字符串 编号, 选项 ?: 时间 选项 ): 字符串**  
返回自输入日期以来已过了多少时间.  
您可以随选项更改语言 .

> 如果复数形式只是添加一个 `s` 最后,你不需要通过它。 它会自动添加它.

类型定义

```typescript
interface TimeSinceOptions {
  day?: string; // day
  days?: string;
  hour?: string; // hour
  hours?: string;
  minute?: string; // minute
  minutes?: string;
  month?: string; // month
  months?: string;
  prefix?: string;
  second?: string; // second
  seconds?: string;
  skipWeeks?: boolean; // true
  suffix?: string; // ago
  week?: string; // week
  weeks?: string;
  year?: string; // year
  years?: string;
}
```
示例

```typescript
timeSince(twoDaysAgo) // 2 days ago
timeSince(twoWeeksAgo, { skipWeeks: true }) // 14 days ago
timeSince(twoDaysAgo, { day: 'Tag', days: 'Tage', prefix: 'Vor', suffix:'' }) // Vor 2 Tage
timeSince(twoWeeeksAgo, { suffix: 'atrás', week: 'semana' }) // 2 semanas atrás
```

**时间戳( 输入 ? : 日期 QQ字符串): 数字**  
拿时间戳来约会.

### 设备

**已忽略**  
检测设备是否处于暗模式 .

**是TouchDevice (): 布尔**  
检测设备是否支持触摸事件 .

**偏好减少运动 ():布尔**  
检测用户是否喜欢减少运动.

### 格式化器

**格式 Boolean( 输入:布尔语): “是” QQ“ 否”**  
将布尔格式化为是/否.

**格式CPF( 输入: 字符串): 字符串**  
将字符串格式化为 CPF.

**格式本地化( 输入: 字符串, 选项? : 格式本地化选项): 字符串**  
使用 locale 格式化 ISO 日期字符串 .

类型定义

```typescript
interface FormatDateLocaleOptions {
  locale?: string; // > 'en-GB'
  showTime?: boolean; // > false
}
```

**格式货币( 输入: 数字, 选项? : 格式货币选项): 字符串**  
将数字格式化为货币字符串.

类型定义

```typescript
interface FormatMoneyOptions {
  decimalChar?: ',' | '.'; // > '.'
  showCents?: boolean; // > false
  symbol?: string; // > '$'
  thousandsChar?: ',' | '.'; // > ','
}
```

**格式PhoneBR( 输入: 字符串): 字符串**  
将字符串格式化为 Brazilian 手机 .

**格式PhoneUS( 输入: 字符串): 字符串**  
将字符串格式化为美国手机.

**格式 PostalCodeBR( 值: 字符串): 字符串**  
将字符串格式化为brazilian zip代码.

### 职能

**调出( 回调 :(... 参数 : 任意 \[ \] 无效, 延迟: 数字): 函数**  
创建调用函数的已取消版本.

**解码(fn:函数):函数**  
将方法从原型中解析.

**execution Time <T = any>(召回:函数):许诺<T>**  
测量函数执行时间 .

**无 (): 无效**  
空函数无所为 .

**一次 < T 扩展 (. 参数 : 参数<any>) QQ 任意 > (fn: T): T**  
创建只调用一次的函数.  
重复呼叫返回第一次引用的价值.

**管子 < T> (. 函数: 阵列 < (参数: T) \* > T)**  
将多个函数合并为一个函数.  
每个函数的输出作为输入传递到下一个函数.

### 杂项

**有条件的 < TReturn > (大小写: Array < Case < TReturn > , 默认 Case? ): () QQ TReturn : TReturn QQ 未定义)**  
用动态表达式大小写替换切换语句.

类型定义

```typescript
type Case<T = void> = [boolean, () => T];
```
示例

```typescript
let type: string = '';

conditional(
[
  [type === 'a', () => console.log('a')],
  [[type].includes('b'), () => console.log('b')],
  [type === 'c', () => console.log('c')],
],
() => console.log('default'),
);
```

**复制到剪贴板( 输入: 字符串): 保证 < boolean >**  
将字符串复制到剪贴板.

示例

```typescript
const toLocaleString = demethodize(Number.prototype.toLocaleString);
const numbers = [2209.6, 124.56, 1048576];

numbers.map(toLocaleString); // ['2,209.6', '124.56', '1,048,576']
```

**获取 DataType( 输入: 未知, 到 LowwerCase = 假): 字符串**  
获取变量的数据类型 .

示例

```typescript
getDataType([1, 2, 3]); // Array
getDataType(/\d+/); // RegExp
getDataType(() => {}, true) // function
```

**不定条件( 条件: 任何, 消息: 字符串): 主张条件**  
检查值是否为真 。 否则,它会扔出.

**是JSON( 输入: 字符串):布尔**  
检查字符串是否是有效的 JSON .

**是必需的( 输入 ? : string = “参数” , 类型: 可构造 = TypeError): 无效**  
扔出可构造类型的错误.

示例

```typescript
function exec(input: string = isRequired('input')) {}
exec() // Throws an TypeError with '"input" is required'

function evaluate(input: string = isRequired('input', SyntaxError)) {}
exec() // Throws an SyntaxError with '"input" is required'
```

**logger( 类型: 字符串, 标题: 字符串, 数据: 任何, 选项? : Logger 选项): 无效**  
日志将信件分组到控制台 .

类型定义

```typescript
interface LoggerOptions {
  collapsed?: boolean; // true
  hideTimestamp?: boolean; // false
  skip?: boolean; // false
  typeColor?: string; // 'gray'
}
```

**在 < T 扩展窗口 > 文档 #% @% HTMLElement #% 事件目标 > () 目标: TQQ无效, ...rest:参数<T\['adEdEvent listener'\]> \[字符串,函数 {{}无效,... 任何\] : 无效**  
将事件听众添加到目标

**关闭 < T 扩展窗口 > 文档 > 文档 > HTMLElement > 事件目标 > ( 目标: TQQ无效, .rest:参数<T\['removeEvent listener'\]> \[弦,函数{{}无效,... 任何\] : 无效**  
从目标中删除事件听众

**无效 < T>( 值: T): T- 无效**  
返回值或无效.

**弹出中心( URL: 字符串, 标题: 字符串, 宽度: 数字, 高度: 数字): 窗口 QQ 无效**  
打开中央弹出窗口并返回.

**px( 值: 字符串 qq数字 qq未定义): 字符串 qq未定义**  
将数字或数字值转换为 px .  
否则,返回值.

**独有( 长度 ? : 数字 = 8, 选项 ? : 唯一选项 ): 字符串**  
返回随机字符串.

类型定义

```typescript
interface UniqueOptions {
  includeLowercase?: boolean; // true
  includeNumbers?: boolean; // true
  includeSymbols?: boolean; // false
  includeUppercase?: boolean; // true
}
```

**uuid (): 字符串**  
返回一个 UUID v4 字符串 .

### 数字

**ceil(输入:数字,数字?:数字=2):数字**  
赛尔小数.

**夹子( 值: 数, 分数 ? 数= 0, 最大值 ? 数= 100): 数**  
限制范围之间的数字 .

**楼层(输入:数字,数字?:数字=2):数字**  
下限小数.

**选项(输入:数字,数字?:数字=2):字符串**  
贴上一个零的号码.

**百分比(输入:数字,总数:数字,数字?:数字=2):数字**  
计算数字相对于总数的百分比.

**随机输入( min: 数字 = 0, 最大值 ? 数字 = 10): 数字**  
返回随机整数.

**圆(输入:数字,数字?:数字=2):数字**  
圆十进制数.

### 对象

**清除对象(输入:平地对象):平地对象**  
从对象中删除未定义值的属性.

**获取Nested Property( 输入: Plain Object QQ, 路径: 字符串): 任意**  
在对象或阵列内获取嵌入属性 .

示例

```typescript
getNestedProperty({ children: { letters: ['a', 'b', 'c'] } }, 'children.letters');
// returns ['a', 'b', 'c']
getNestedProperty({ children: { letters: ['a', 'b', 'c'] } }, 'children.letters.1');
// returns 'b'
getNestedProperty([{ a: 5 }, { a: 7 }, { a: 10 }], '0.a');
// returns 5
```

您也可以使用通配符( +) 来获取多个数组值 :

```typescript
getNestedProperty([{ a: 5 }, { a: 7 }, { a: 10 }], '+.a');
// returns [5, 7, 10]
getNestedProperty({ children: [{ a: 5 }, { a: 7 }, { a: 10 }] }, 'children.+.a');
// returns [5, 7, 10]
```

**倒数键( 输入: Plain Object): Plain Object**  
倒转对象键和值 .

**密钥密钥( 输入: Plain Object): Plain Object**  
将密钥设定为值 .

**合并Props < TDefaultProps, TProps > (默认: TDefaultProps, 道具: TProps): TProps**  
将默认Props与收到的道具的字面值合并,从中去除将覆盖默认Props的未定义值.  
结果是一个具有默认Props作为必要属性的类型安全对象.

**对象输入 < T extend Plain Object< any> (输入: T): Array{} \[K 在 keyof T\] - ? : \[K, T\[K\]\]} \[keyof T\]\]\]**  
类型安全对象. entries ().

**对象Keys <Text PlainObject<Any>(输入:T): Array<Keyof T>**  
类型安全对象. keys ().

**对象ToArray( 输入: Plain Object, 包括 Only? 字符串): 阵列 < Plain Object >**  
将对象转换为一系列对象.

**省略 <T 延伸 Plain Object, K 扩展 keyof T> (输入: T,... filter: K\[\] ): 普通对象**  
从对象中删除属性.

**pick <T extend Plain Object, K extend key of T > (输入: T,... filter: K\[\]): 普通对象**  
从对象中选择属性.

**查询 StringFormat( 输入: PlainObject, 选项? : 查询StringFormat 选项): 字符串**  
将一个浅的天体刻入查询字符串.

类型定义

```typescript
interface QueryStringFormatOptions {
  addPrefix?: boolean;
  encodeValuesOnly?: boolean;
  encoder?: (uri: string) => string;
}
```

**查询StringParse( 输入: 字符串): 平面对象**  
解析查询字符串 .

**排序对象键(输入:平面对象):平面对象**  
排序对象键.

### 统计

**平均值(输入:数字\[\],精确度?:数字):数字**  
返回两个或两个以上数字的平均值.

**中位数( 输入: 数字 \[\]): 数字**  
返回两个或两个以上数字的中位数.

**模式(输入:数字\[\]):数字**  
返回两个或两个以上数字的模式.

### 字符串

**使用( 输入: 字符串): 字符串**  
资本化出第一个字母.

**清理HTML( 输入: 字符串): 字符串**  
清理HTML内容.

**清理NummericString(输入:字符串):字符串**  
清净一一数相相.

**清除URI( 输入: 字符串): 字符串**  
清理URI字符.

**获取初始化( 输入: 字符串): 字符串**  
从名字取首字母.

**复数化( 单数: 字符串, 复数: 字符串 qq 未定义, 数量: 数量): 字符串**  
根据数量返回单数或复数.

> 如果复数形式只是添加一个 `s` 最后,你不需要通过它。 它会自动添加它.

**删除 Accents( 输入: 字符串): 字符串**  
删除口音.

**删除 Emojis( 输入: 字符串): 字符串**  
取出爱莫吉斯.

**删除Empty Tags( 输入: 字符串): 字符串**  
删除空的 HTML 标记( 包括空白) .

**删除不可打印的化学式( 输入: 字符串): 字符串**  
删除不可打印的 ASCII 字符 .

**删除标签( 输入: 字符串): 字符串**  
删除 HTML 标记 .

**删除白空间( 输入: 字符串): 字符串**  
删除空白 .

**shirtify( 输入: 字符串): 字符串**  
将字符串格式化为弹簧.

### 验证器

**为 ValidCPF( 值: 字符串):布尔**  
检查CPF是否有效 .

**是Valid电子邮件( 值: 字符串):布尔**  
检查电子邮件是否有效 .

`@throws`  
**验证 Password(密码:字符串,选项?:验证Password 选项):布尔**  
验证密码长度和所需的字符 .

```typescript
interface ValidatePasswordOptions {
  maxLength?: string;
  maxLengthMessage?: string;
  minLength?: string;
  minLengthMessage?: string;
  regex?: RegExp;
  requiredCharactersMessage?: string;
}
```

## 许可证

麻省理工学院

## 常见问题

### @gilbarbara/helpers 是什么？

收集有用的职能

### 如何安装 @gilbarbara/helpers？

在项目目录运行 npm install @gilbarbara/helpers，或使用 pnpm add / yarn add / bun add。

### @gilbarbara/helpers 支持 TypeScript 吗？

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

### @gilbarbara/helpers 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gilbarbara/helpers 可以商用吗？

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

### @gilbarbara/helpers 的下载量有多少？

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

### @gilbarbara/helpers 还在维护吗？

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

