cli-truncate中文文档|cli-truncate js中文教程|解析

npm npmdoc 3年前 (2021-12-30) 575次浏览

cli-truncate中文文档|cli-truncate js中文教程|解析

安装命令:npm i cli-truncate

cli-截断

在终端中将字符串截断为特定宽度

优雅地处理ANSI 转义就像一个带有chalk. 它还支持 Unicode 代理对和全角字符。

安装

$ npm install cli-truncate

用法

import cliTruncate from 'cli-truncate';

cliTruncate('unicorn', 4);
//=> 'uni…'

// Truncate at different positions
cliTruncate('unicorn', 4, {position: 'start'});
//=> '…orn'

cliTruncate('unicorn', 4, {position: 'middle'});
//=> 'un…n'

cliTruncate('unicorns rainbow dragons', 6, {position: 'end'})
//=> 'unico…'

cliTruncate('\u001B[31municorn\u001B[39m', 4);
//=> '\u001B[31muni\u001B[39m…'

// Truncate Unicode surrogate pairs
cliTruncate('uni\uD83C\uDE00corn', 5);
//=> 'uni\uD83C\uDE00…'

// Truncate fullwidth characters
cliTruncate('안녕하세요', 3);
//=> '안…'

// Truncate the paragraph to the terminal width
const paragraph = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.';
cliTruncate(paragraph, process.stdout.columns));
//=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'

应用程序接口

cliTruncate(文本,列,选项?)

文本

类型: string

要截断的文本。

类型: number

在终端中占据的列数。

选项

类型: object

位置

类型:string

默认值:
'end'

值:
'start' 'middle' 'end'

截断字符串的位置。

空间

类型:boolean

默认:
false

在文本和省略号之间添加一个空格。

import cliTruncate from 'cli-truncate';

cliTruncate('unicorns', 5, {space: false});
//=> 'unic…'

cliTruncate('unicorns', 5, {space: true});
//=> 'uni …'

cliTruncate('unicorns', 6, {position: 'start', space: true});
//=> '… orns'

cliTruncate('unicorns', 7, {position: 'middle', space: true});
//=> 'uni … s'
首选空间截断

类型:boolean

默认:
false

如果字符串在实际断点的 3 个字符内,则从空格中截断字符串。

import cliTruncate from 'cli-truncate';

cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true})
//=> '…rainbow dragons'

// without preferTruncationOnSpace
cliTruncate('unicorns rainbow dragons', 20, {position: 'start'})
//=> '…rns rainbow dragons'

cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true})
//=> 'unicorns…dragons'

cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true})
//=> 'unico…'

// preferTruncationOnSpace would have no effect if space isn't found within next 3 indexes
cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncationOnSpace: true})
//=> 'uni…ns'
截断字符

类型:string

默认:

在断点处使用的字符。

import cliTruncate from 'cli-truncate';

cliTruncate('unicorns', 5, {position: 'end'});
//=> 'unic…'

cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: '.'});
//=> 'unic.'

cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: ''});
//=> 'unico'

有关的

  • wrap-ansi – 用 ANSI 转义码对字符串进行 Wordwrap
  • slice-ansi – 用 ANSI 转义码对字符串进行切片


通过 Tidelift 订阅获得对此软件包的专业支持



Tidelift 有助于使维护者的开源可持续发展,同时为公司提供

有关其依赖项的安全性、维护和许可的保证。
项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:cli-truncate中文文档|cli-truncate js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}