Socket
Socket
Sign inDemoInstall

word-wrap

Package Overview
Dependencies
0
Maintainers
2
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    word-wrap

Wrap words to a specified length.


Version published
Maintainers
2
Install size
11.6 kB
Created

Package description

What is word-wrap?

The word-wrap npm package is a simple utility that allows you to wrap words to a specified width. This can be particularly useful when dealing with text formatting in console applications or when generating text content that needs to adhere to certain width constraints.

What are word-wrap's main functionalities?

Basic word wrapping

This feature allows you to wrap a long string of text to a specified width. The 'width' option defines the maximum length of the lines in the output.

const wrap = require('word-wrap');
const text = 'This is a long piece of text that needs to be wrapped.';
const wrappedText = wrap(text, {width: 20});
console.log(wrappedText);

Custom indentation

This feature allows you to add custom indentation to the beginning of each line in the wrapped text. The 'indent' option specifies the string to use for indentation.

const wrap = require('word-wrap');
const text = 'This text will have an indentation.';
const wrappedText = wrap(text, {width: 20, indent: '    '});
console.log(wrappedText);

Trimming

This feature enables the trimming of leading and trailing whitespace from the input text before wrapping. The 'trim' option is a boolean that activates this behavior.

const wrap = require('word-wrap');
const text = '   This text has extra spaces that will be trimmed.   ';
const wrappedText = wrap(text, {width: 20, trim: true});
console.log(wrappedText);

Custom newline character

This feature allows you to specify a custom newline character to be used in the wrapped text. The 'newline' option lets you define what characters to use for line breaks.

const wrap = require('word-wrap');
const text = 'This text will use a custom newline character.';
const wrappedText = wrap(text, {width: 20, newline: '\n\n'});
console.log(wrappedText);

Cut long words

This feature allows you to specify whether long words should be cut to fit the specified width. The 'cut' option is a boolean that, when true, will break a word that is longer than the specified width.

const wrap = require('word-wrap');
const text = 'A verylongwordthatneedstobewrapped.';
const wrappedText = wrap(text, {width: 10, cut: true});
console.log(wrappedText);

Other packages similar to word-wrap

Readme

Source

word-wrap NPM version NPM monthly downloads NPM total downloads Linux Build Status

Wrap words to a specified length.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save word-wrap

Usage

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:

  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

image

options.width

Type: Number

Default: 50

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

Example:

wrap(str, {width: 60});

options.indent

Type: String

Default: `` (two spaces)

The string to use at the beginning of each line.

Example:

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

options.newline

Type: String

Default: \n

The string to use at the end of each line.

Example:

wrap(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:

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

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:

wrap(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:

wrap(str, {cut: true});

About

Contributing

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

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:

$ npm install && npm test
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:

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

You might also be interested in these 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: Returns an array of unique words, or the number of occurrences of each word in… more | homepage
  • wordcount: Count the words in a string. Support for english, CJK and Cyrillic. | homepage

Contributors

CommitsContributor
47jonschlinkert
7OlafConijn
3doowb
2aashutoshrathi
2lordvlad
2hildjj
1danilosampaio
12fd
1leonard-thieu
1mohd-akram
1toddself
1wolfgang42
1zachhale

Author

Jon Schlinkert

License

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


This file was generated by verb-generate-readme, v0.8.0, on July 22, 2023.

Keywords

FAQs

Last updated on 22 Jul 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc