Skip to content

Repository files navigation

slice-ansi XO: Linted

Slice a string with ANSI escape codes

Install

npm install slice-ansi

Usage

importchalkfrom'chalk';importsliceAnsifrom'slice-ansi';conststring='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, startSlice, endSlice?)

string

Type: string

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

startSlice

Type: number

Zero-based visible-column index at which to start the slice. Grapheme clusters (for example, emoji sequences and combining marks) are kept intact.

endSlice

Type: number

Zero-based visible-column index at which to end the slice. If a full grapheme cluster would cross endSlice, it is excluded.

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

About

Slice a string with ANSI escape codes

Resources

Security policy

Stars

51 stars

Watchers

4 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages