让开源，少一点语言距离。
npm包中文文档

@codechecks/type-coverage-watcher

中文文档
0.1.3发布于 2019/08/03MITTypeScriptCommonJS近 30 天下载 3547

Track missing type coverage in TypeScript projects to ensure type safety

原始使用文档
中文原文
文档目录7 节
  1. Type Coverage Watcher
  2. Install
  3. Usage
  4. API
  5. typeCoverageWatcher(options: Options): Promise<void>
  6. Contributing
  7. Licence

codechecks.io

Type Coverage Watcher

Track missing type coverage in TypeScript projects to ensure type safety

Build Status Software License codechecks.io

Install

npm add --save-dev @codechecks/type-coverage-watcher

Usage

Are you new to codechecks? Check out getting started guide (it's simple)!

Add to your codechecks.yml file:

checks:
  - name: type-coverage-watcher
  # ...

Under the hood it uses type-coverage package.

API

typeCoverageWatcher(options: Options): Promise<void>

options

interface Options {
  tsconfigPath?: string; //defaults to tsconfig.json
  name?: string; // defaults to Type Coverage
  ignoreFiles?: string[];
  ignoreCatch?: boolean;
  atLeast?: number;
  strict?: boolean;
}
tsconfigPath

optional string

Default: tsconfig.json

Path to typescript project configuration

name

optional string

Defaults: Type Coverage

Specify the name for check. Might be useful in monorepos.

ignoreFiles

optional string[]

Defaults: undefined

Specify the ignored for checks files.

ignoreCatch

optional string

Defaults: undefined

See type-coverage's description for the reference.

atLeast

optional number

Defaults: undefined

Example: atLeast: 99

Fail if coverage rate < this value.

strict

optional string

Defaults: undefined

See type-coverage's description for the reference.

Contributing

All contributions are welcomed. Read more in CONTRIBUTING.md

Licence

MIT @ codechecks.io

版本与发布记录

@codechecks/type-coverage-watcher 共发布 7 个版本，首次发布于 2019/03/29；过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.3latest2019/08/037 年前
0.1.22019/08/027 年前
0.1.12019/06/307 年前
0.1.02019/05/237 年前
0.0.82019/04/037 年前
0.0.72019/04/017 年前

关于 @codechecks/type-coverage-watcher 的常见问题

@codechecks/type-coverage-watcher 是什么？

Track missing type coverage in TypeScript projects to ensure type safety

如何安装 @codechecks/type-coverage-watcher？

在项目目录运行 npm install @codechecks/type-coverage-watcher，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@codechecks/client（^0.1.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

@codechecks/type-coverage-watcher 支持 TypeScript 吗？

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

@codechecks/type-coverage-watcher 支持 ESM 还是 CommonJS？

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

@codechecks/type-coverage-watcher 需要什么版本的 Node.js？

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

@codechecks/type-coverage-watcher 可以商用吗？

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

@codechecks/type-coverage-watcher 的下载量有多少？

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

@codechecks/type-coverage-watcher 还在维护吗？

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