word-wrap

Wrap words to a specified length.

Install

Install with npm:

1$ npm install --save word-wrap

Usage

1var wrap = require('word-wrap');
2
3wrap('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.');

Results in:

  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

options.width

Type: Number

Default: 50

The width of the text before wrapping to a new line.

Example:

1wrap(str, {width: 60});

options.indent

Type: String

Default: `` (none)

The string to use at the beginning of each line.

Example:

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

options.newline

Type: String

Default: \n

The string to use at the end of each line.

Example:

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

options.escape

Type: function

Default: function(str){return str;}

An escape function to run on each line after splitting them.

Example:

1var xmlescape = require('xml-escape');
2wrap(str, {
3  escape: function(string){
4    return xmlescape(string);
5  }
6});

options.trim

Type: Boolean

Default: false

Trim trailing whitespace from the returned string. This option is included since .trim() would also strip the leading indentation from the first line.

Example:

1wrap(str, {trim: true});

options.cut

Type: Boolean

Default: false

Break a word between any two letters when the word is longer than the specified width.

Example:

1wrap(str, {cut: true});

About

Related projects

• common-words: Updated list (JSON) of the 100 most common words in the English language. Useful for… more | homepage
• shuffle-words: Shuffle the words in a string and optionally the letters in each word using the… more | homepage
• unique-words: Return the unique words in a string or array. | homepage
• wordcount: Count the words in a string. Support for english, CJK and Cyrillic. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
43	jonschlinkert
2	lordvlad
2	hildjj
1	danilosampaio
1	2fd
1	toddself
1	wolfgang42
1	zachhale

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

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

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

1$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on June 02, 2017.