mirror of https://codeberg.org/keyoxide/doipjs.git synced 2024-12-22 22:49:28 -07:00

History

Yarmo Mackenbach e996bc8023 Initial commit		2020-10-23 22:35:53 +02:00
..
index.js	Initial commit	2020-10-23 22:35:53 +02:00
license	Initial commit	2020-10-23 22:35:53 +02:00
package.json	Initial commit	2020-10-23 22:35:53 +02:00
readme.md	Initial commit	2020-10-23 22:35:53 +02:00

readme.md

wrap-ansi

Wordwrap a string with ANSI escape codes

Install

$ npm install 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));

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}

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

Type: Object

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.

trim