word-wrap

Wrap words to a specified length.

Install with npm

1

npm i word-wrap --save

Usage

1
2
3

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.');

Results in:

1
2
3
4
5

  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:

1

wrap(str, {width: 60});

options.indent

Type: String

Default: (two spaces)

The string to use at the beginning of each line.

Example:

1

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

options.newline

Type: String

Default: \n

The string to use at the end of each line.

Example:

1

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

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:

1

wrap(str, {trim: true});

Related projects

• wordcount: Count the words in string. Has basic support for Cyrillic and CJK.
• unique-words: Return the unique words in a string or array.
• common-words: Updated list (JSON) of the 100 most common words in the English language. Useful for excluding these words from arrays.
• shuffle-words: Shuffle the words in a string and optionally the letters in each word using the Fisher-Yates algorithm. Useful for creating test fixtures, benchmarking samples, etc.

Running tests

Install dev dependencies.

1

npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

This file was generated by verb-cli on March 07, 2015.