node_modules/wrap-ansi/readme.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

wrap-ansi

Wordwrap a string with ANSI escape codes

Install

$ npm install --save wrap-ansi

Usage

const chalk = require('chalk');
const wrapAnsi = require('wrap-ansi');

const input = 'The quick brown ' + chalk.red('fox jumped over ') +
    'the lazy ' + chalk.green('dog and then ran away with the unicorn.');

console.log(wrapAnsi(input, 20));

API

wrapAnsi(input, columns, [options])

Wrap words to the specified column width.

input

Type: string

String with ANSI escape codes. Like one styled by chalk.

columns

Type: number

Number of columns to wrap the text to.

options

hard

Type: boolean Default: false

By default the wrap is soft, meaning long words may extend past the column width. Setting this to true will make it hard wrap at the column width.

wordWrap

Type: boolean Default: true

By default, an attempt is made to split words at spaces, ensuring that they don't extend past the configured columns. If wordWrap is false, each column will instead be completely filled splitting words as necessary.

Related

• slice-ansi - Slice a string with ANSI escape codes
• cli-truncate - Truncate a string to a specific width in the terminal
• chalk - Terminal string styling done right
• jsesc - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.

License

MIT © Sindre Sorhus

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.