cli-width

中文文档
4.1.0发布于 2023/08/06ISCTypeScriptCommonJS零依赖近 30 天下载 3.6亿

获得 stdout 窗口宽度, 有两个倒置后, tty 和默认值 .

中文使用文档
文档目录5 节
  1. 使用量
  2. API 密码
  3. cliWidth( [选项])
  4. 实例
  5. 测试

宽度

获得 Stdout 窗口宽度, 有四个倒背, tty, (中文(简体) ), output.columns,一个自定义环境变量,然后是默认值.

npm version Build Status Coverage Status

被测试于节点v12到v20. 包括类型脚本.

使用量

npm install --save cli-width
const cliWidth = require('cli-width');

cliWidth(); // maybe 204 :)

您也可以设置 CLI_WIDTH 环境变量.

如果没有一个方法支持, 环境变量没有设置, 默认宽度值将是 0,可以使用可配置 options。 。 。 .

API 密码

cliWidth( [选项])

cliWidth 可用 options 参数,可能属性为:

  • 默认窗口< 数 > 定义在没有可用方法的情况下使用的默认值,默认为 0
  • 产出<对象> 用于读取宽度值的流,默认为 process.stdout
  • ty( tt) (英语)<对象> 尝试读取宽度的 TTY 模块从倒置,默认到 require('tty')

实例

定义默认宽度值和要尝试读取的流输出:

const cliWidth = require('cli-width');
const ttys = require('ttys');

cliWidth({
  defaultWidth: 80,
  output: ttys.output,
});

定义不同的 tty 模块读取宽度 :

const cliWidth = require('cli-width');
const ttys = require('ttys');

cliWidth({
  tty: ttys,
});

测试

npm install
npm test

覆盖范围可以产生 npm run coverage。 。 。 .

版本与发布记录

cli-width 共发布 12 个版本,首次发布于 2015/01/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.1.0latest2023/08/063 年前
4.0.02022/03/294 年前
3.0.02020/04/146 年前
2.2.12020/04/146 年前
2.2.02017/08/229 年前
2.1.12017/08/229 年前

关于 cli-width 的常见问题

cli-width 是什么?

获得 stdout 窗口宽度, 有两个倒置后, tty 和默认值 .

如何安装 cli-width?

在项目目录运行 npm install cli-width,或使用 pnpm add / yarn add / bun add。

cli-width 支持 TypeScript 吗?

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

cli-width 支持 ESM 还是 CommonJS?

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

cli-width 需要什么版本的 Node.js?

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

cli-width 可以商用吗?

cli-width 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

cli-width 的下载量有多少?

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

cli-width 还在维护吗?

最新版本 4.1.0 发布于 2023/08/06(3 年前);至今共发布 12 个版本,其中过去 12 个月发布了 0 个;首次发布于 2015/01/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。