# @blackglory/types 中文文档

规范地址：https://npmcn.com/package/%40blackglory/types/

版本：1\.4\.0
npm 元数据更新时间：2022-10-30T07:58:46.422Z
中文译文更新时间：2026-11-08T05:51:34.229Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：305 kB，157 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12
- 运行依赖：2 个
- 首次发布：2020-08-12T06:43:34.748Z
- 最新版本发布：2022-10-30T07:58:46.343Z
- 近 30 天下载量：4513（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 0 个）

## 中文简介

JavaScript 和 Typescript 的守护类型 .

## 安装

```sh
npm install @blackglory/types
```

也可以使用：`pnpm add @blackglory/types`、`yarn add @blackglory/types`、`bun add @blackglory/types`

## README

# 类型

JavaScript 和 Typescript 的守护类型 .

## 安装

```sh
npm install --save @blackglory/types
# or
yarn add @blackglory/types
```

## API 密码

```ts
function isArray<T>(val: unknown): val is Array<T>
function isntArray<T>(val: T): val is Exclude<T, Array<unknown>>

function isEmptyArray(val: unknown[]): boolean
function isntEmptyArray<T>(val: T[]): val is NonEmptyArray<T>

function isAsyncIterable<T>(val: unknown): val is AsyncIterable<T>
function isntAsyncIterable<T>(val: T): val is Exclude<T, AsyncIterable<unknown>>

function isBigInt(val: unknown): val is bigint
function isntBigInt<T>(val: T): val is Exclude<T, bigint>

function isBoolean(val: unknown): val is boolean

function isChar(val: unknown): val is string
function isntChar(val: unknown): boolean

function isDate(val: unknown): val is Date
function isntDate<T>(val: T): val is Exclude<T, Date>

function inEnum<T>(val: unknown, _enum: object): val is T

function isError(val: unknown): val is Error
function isntError<T>(val: T): val is Exclude<T, Error>

function isFalsy(val: unknown): val is Falsy
function isntFalsy<T>(val: T): val is Exclude<T, Falsy>

function isFunction<T extends Function = (...args: any[]) => any>(
  val: unknown
): val is T
function isntFunction<T>(val: T): val is Exclude<T, Function>

function isIterable<T>(val: unknown): val is Iterable<T>
function isntIterable<T>(val: T): val is Exclude<T, Iterable<unknown>>

function isJson(val: unknown): Json
function isntJson<T>(val: T): val is Exclude<T, Json>

function isJsonable(val: unknown): boolean
function isntJsonable<T>(val: T): boolean

function isNull(val: unknown): val is null
function isntNull<T>(val: T): val is Exclude<T, null>

function isNullish(val: unknown): val is Nullish
function isntNullish<T>(val: T): val is Exclude<T, Nullish>

function isNumber(val: unknown): val is number
function isntNumber<T>(val: T): val is Exclude<T, number>

function isFinite(val: number): boolean
function isPositiveInfinity(val: number): boolean
function isNegativeInfinity(val: number): boolean
function isNaN(val: number): boolean
function isntNaN(val: number): boolean

function isObject(val: unknown): val is object & Record<string | symbol | number, unknown>
function isntObject<T>(val: T): val is Exclude<T, object & Record<string | symbol | number, unknown>>

function isPlainObject(val: unknown): val is object & Record<string | symbol | number, unknown>
function isntPlainObject<T>(val: T): val is Exclude<T, object & Record<string | symbol | number, unknown>>

function isEmptyObject(val: object): boolean
function isntEmptyObject(val: object): boolean

function isPromise<T>(val: unknown): val is Promise<T>
function isntPromise<T>(val: T): val is Exclude<T, Promise<unknown>>

function isntPromiseLike<T>(val: T): val is Exclude<T, PromiseLike<unknown>>
function isPromiseLike<T>(val: unknown): val is PromiseLike<T>

function isString(val: unknown): val is string
function isntString<T>(val: T): val is Exclude<T, string>

function isUndefined(val: unknown): val is undefined
function isntUndefined<T>(val: T): val is Exclude<T, undefined>

function isAbsoluteURL(str: string): boolean

function isRegExp(val: unknown): val is RegExp
function isntRegExp<T>(val: T): val is Exclude<T, RegExp>

function isSymbol(val: unknown): val is symbol
function isntSymbol<T>(val: T): val is Exclude<T, symbol>
```

## 常见问题

### @blackglory/types 是什么？

JavaScript 和 Typescript 的守护类型 \.

### 如何安装 @blackglory/types？

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

### @blackglory/types 支持 TypeScript 吗？

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

### @blackglory/types 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @blackglory/types 需要什么版本的 Node\.js？

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

### @blackglory/types 可以商用吗？

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

### @blackglory/types 的下载量有多少？

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

### @blackglory/types 还在维护吗？

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

