README.md

@snickbit/ansi

Table of contents

Interfaces

• AnsiControls
• Styles

Type Aliases

• AnsiMethods
• AnsiRenderFn
• BackgroundColor
• CodePair
• Color
• Modifier
• StyleCategory

Variables

• ansiStyles

Functions

• ansiRegex
• generateStyleCodes
• stripAnsi

Type Aliases

AnsiMethods

Ƭ AnsiMethods: Object

Type declaration

Name	Type
ansi	AnsiRenderFn
ansi16m	AnsiRenderFn
ansi256	AnsiRenderFn

---

AnsiRenderFn

Ƭ AnsiRenderFn: (...args: any) => string

Type declaration

▸ (...args): string

Parameters

Name	Type
...args	any

Returns

string

---

BackgroundColor

Ƭ BackgroundColor: "bgBlack" | "bgBlackBright" | "bgBlue" | "bgBlueBright" | "bgCyan" | "bgCyanBright" | "bgGray" | "bgGreen" | "bgGreenBright" | "bgGrey" | "bgMagenta" | "bgMagentaBright" | "bgRed" | "bgRedBright" | "bgWhite" | "bgWhiteBright" | "bgYellow" | "bgYellowBright"

---

CodePair

Ƭ CodePair: [number, number]

---

Color

Ƭ Color: "black" | "blackBright" | "blue" | "blueBright" | "cyan" | "cyanBright" | "gray" | "green" | "greenBright" | "grey" | "magenta" | "magentaBright" | "red" | "redBright" | "white" | "whiteBright" | "yellow" | "yellowBright"

---

Modifier

Ƭ Modifier: "bold" | "dim" | "hidden" | "inverse" | "italic" | "overline" | "reset" | "strikethrough" | "underline"

---

StyleCategory

Ƭ StyleCategory<Allowed>: Partial<AnsiControls> & Partial<AnsiMethods> & Record<Allowed, CodePair>

Type parameters

Name	Type
Allowed	extends string

Variables

ansiStyles

• Const ansiStyles: Styles

Functions

ansiRegex

▸ ansiRegex(onlyFirst?): RegExp

Ansi regular expression

Parameters

Name	Type	Default value
onlyFirst	boolean	false

Returns

RegExp

---

generateStyleCodes

▸ generateStyleCodes(): StyleCodes

Returns

StyleCodes

---

stripAnsi

▸ stripAnsi(text): string

Remove ansi escape codes from a string

Parameters

Name	Type
text	string

Returns

string