JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 164725861
  • Score
    100M100P100Q250904F
  • License MIT

Wordwrap a string with ANSI escape codes

Package Exports

  • wrap-ansi

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wrap-ansi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

wrap-ansi Build Status Coverage Status

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.

  • slice-ansi - Slice a string with ANSI escape codes
  • chalk - Terminal string styling done right
  • jsesc - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.

License

MIT © Sindre Sorhus