自动换行

将单词换行到指定的长度。

请考虑跟随这个项目的作者， Jon Schlinkert,并考虑主演该项目，以展示您的: 心: 和支持。

安装

安装与 npm：

$ npm install --save word-wrap

用法

var wrap = require('word-wrap');

wrap('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.');

结果:

  Lorem ipsum dolor sit amet, consectetur adipiscing
  elit, sed do eiusmod tempor incididunt ut labore
  et dolore magna aliqua. Ut enim ad minim veniam,
  quis nostrud exercitation ullamco laboris nisi ut
  aliquip ex ea commodo consequat.

选项

options.width

类型: Number

默认值: 50

在换行到新行之前的文本宽度。

例子:

wrap(str, {width: 60});

options.indent

类型: String

默认值：‘ ’（两个空格）

在每行开头使用的字符串。

例子:

wrap(str, {indent: '      '});

options.newline

类型: String

默认值: \n

在每行末尾使用的字符串。

例子:

wrap(str, {newline: '\n\n'});

options.escape

类型: function

默认值: function(str){return str;}

一个转义函数，在分隔行之后在每行上运行。

例子:

var xmlescape = require('xml-escape');
wrap(str, {
  escape: function(string){
    return xmlescape(string);
  }
});

options.trim

类型: Boolean

默认值: false

从返回的字符串中删除尾随空格。这个选项是自 .trim() 还将从第一行去掉前导缩进。

例子:

wrap(str, {trim: true});

options.cut

类型: Boolean

默认值: false

当单词长度超过指定宽度时，将单词分隔为任意两个字母。

例子:

wrap(str, {cut: true});

关于

$ npm install && npm test

$ npm install -g verbose/verb#dev verb-generate-readme && verb

相关项目

你也可能对这些项目感兴趣:

• 常用单词：更新的100个最常见的英语单词列表（JSON）。有用的… 更多的 | 首页
• shuffle-words：对字符串中的单词进行洗牌，并使用… 更多的 | 首页
• 唯一单词：返回唯一单词的数组，或者每个单词在…中出现的次数。 更多的 | 首页
• wordcount：计算字符串中的单词数。支持英语，CJK和西里尔文。| 首页

贡献者

| 提交 | 贡献者 |
| --- | --- |
| 47 | jonschlinkert |
| 7 | OlafConijn |
| 3 | doowb |
| 2 | aashutoshrathi |
| 2 | lordvlad |
| 2 | hildjj |
| 1 | danilosampaio |
| 1 | 2 fd |
| 1 | leonard-thieu |
| 1 | mohd-akram |
| 1 | toddself |
| 1 | wolfgang42 |
| 1 | zachhale |

作者

Jon Schlinkert

• GitHub概要
• Twitter
• LinkedIn的资料

许可证

版权所有©2023 Jon Schlinkert。 根据 麻省理工学院的许可。

该文件由 动词-生成-自述文件2023年7月22日，v0.8.0。