Slice a string with ANSI escape codes


Keywords
slice, string, ansi, styles, color, colour, colors, terminal, console, cli, tty, escape, formatting, rgb, 256, shell, xterm, log, logging, command-line, text
License
MIT
Install
npm install slice-ansi@4.0.0

Documentation

slice-ansi Build Status XO: Linted

Slice a string with ANSI escape codes

Install

$ npm install slice-ansi

Usage

const chalk = require('chalk');
const sliceAnsi = require('slice-ansi');

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

console.log(sliceAnsi(string, 20, 30));

API

sliceAnsi(string, beginSlice, endSlice?)

string

Type: string

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

beginSlice

Type: number

Zero-based index at which to begin the slice.

endSlice

Type: number

Zero-based index at which to end the slice.

Related

  • wrap-ansi - Wordwrap a string with ANSI escape codes
  • cli-truncate - Truncate a string to a specific width in the terminal
  • chalk - Terminal string styling done right

Maintainers


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.