mirror of https://github.com/musix-org/musix-oss synced 2024-11-13 02:20:18 +00:00

History

MatteZ02 30022c7634 Modules		2020-03-03 22:30:50 +02:00
..
index.js	Modules	2020-03-03 22:30:50 +02:00
license	Modules	2020-03-03 22:30:50 +02:00
package.json	Modules	2020-03-03 22:30:50 +02:00
readme.md	Modules	2020-03-03 22:30:50 +02:00

readme.md

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.

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.