Logo for jsDocs.io

ansi-colors

  • Version 4.1.3
  • Published
  • 26.1 kB
  • No dependencies
  • MIT license

Install

npm i ansi-colors
yarn add ansi-colors
pnpm add ansi-colors

Overview

Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in replacement for chalk, kleur and turbocolor (without the dependencies and rendering bugs).

Index

Variables

Functions

Interfaces

Variables

variable ansiRegex

const ansiRegex: RegExp;

    variable bgBlack

    const bgBlack: StyleFunction;

      variable bgBlackBright

      const bgBlackBright: StyleFunction;

        variable bgBlue

        const bgBlue: StyleFunction;

          variable bgBlueBright

          const bgBlueBright: StyleFunction;

            variable bgCyan

            const bgCyan: StyleFunction;

              variable bgCyanBright

              const bgCyanBright: StyleFunction;

                variable bgGreen

                const bgGreen: StyleFunction;

                  variable bgGreenBright

                  const bgGreenBright: StyleFunction;

                    variable bgMagenta

                    const bgMagenta: StyleFunction;

                      variable bgMagentaBright

                      const bgMagentaBright: StyleFunction;

                        variable bgRed

                        const bgRed: StyleFunction;

                          variable bgRedBright

                          const bgRedBright: StyleFunction;

                            variable bgWhite

                            const bgWhite: StyleFunction;

                              variable bgWhiteBright

                              const bgWhiteBright: StyleFunction;

                                variable bgYellow

                                const bgYellow: StyleFunction;

                                  variable bgYellowBright

                                  const bgYellowBright: StyleFunction;

                                    variable black

                                    const black: StyleFunction;

                                      variable blackBright

                                      const blackBright: StyleFunction;

                                        variable blue

                                        const blue: StyleFunction;

                                          variable blueBright

                                          const blueBright: StyleFunction;

                                            variable bold

                                            const bold: StyleFunction;

                                              variable cyan

                                              const cyan: StyleFunction;

                                                variable cyanBright

                                                const cyanBright: StyleFunction;

                                                  variable dim

                                                  const dim: StyleFunction;

                                                    variable enabled

                                                    let enabled: boolean;

                                                      variable gray

                                                      const gray: StyleFunction;

                                                        variable green

                                                        const green: StyleFunction;

                                                          variable greenBright

                                                          const greenBright: StyleFunction;

                                                            variable grey

                                                            const grey: StyleFunction;

                                                              variable hidden

                                                              const hidden: StyleFunction;

                                                                variable inverse

                                                                const inverse: StyleFunction;

                                                                  variable italic

                                                                  const italic: StyleFunction;

                                                                    variable magenta

                                                                    const magenta: StyleFunction;

                                                                      variable magentaBright

                                                                      const magentaBright: StyleFunction;

                                                                        variable red

                                                                        const red: StyleFunction;

                                                                          variable redBright

                                                                          const redBright: StyleFunction;

                                                                            variable reset

                                                                            const reset: StyleFunction;

                                                                              variable strikethrough

                                                                              const strikethrough: StyleFunction;

                                                                                variable styles

                                                                                const styles: StylesType<StyleType>;

                                                                                  variable symbols

                                                                                  const symbols: SymbolsType;

                                                                                    variable underline

                                                                                    const underline: StyleFunction;

                                                                                      variable visible

                                                                                      let visible: boolean;

                                                                                        variable white

                                                                                        const white: StyleFunction;

                                                                                          variable whiteBright

                                                                                          const whiteBright: StyleFunction;

                                                                                            variable yellow

                                                                                            const yellow: StyleFunction;

                                                                                              variable yellowBright

                                                                                              const yellowBright: StyleFunction;

                                                                                                Functions

                                                                                                function create

                                                                                                create: () => typeof ansiColors;

                                                                                                  function ok

                                                                                                  ok: (...args: string[]) => string;

                                                                                                  • Outputs a string with check-symbol as prefix

                                                                                                  function strip

                                                                                                  strip: (s: string) => string;

                                                                                                  • Remove styles from string

                                                                                                  function stripColor

                                                                                                  stripColor: (s: string) => string;

                                                                                                  • Remove styles from string

                                                                                                  function unstyle

                                                                                                  unstyle: (s: string) => string;

                                                                                                  • Remove styles from string

                                                                                                  Interfaces

                                                                                                  interface StyleFunction

                                                                                                  interface StyleFunction extends StylesType<StyleFunction> {}

                                                                                                    call signature

                                                                                                    (s: string): string;

                                                                                                      Package Files (1)

                                                                                                      Dependencies (0)

                                                                                                      No dependencies.

                                                                                                      Dev Dependencies (5)

                                                                                                      Peer Dependencies (0)

                                                                                                      No peer dependencies.

                                                                                                      Badge

                                                                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ansi-colors.

                                                                                                      • Markdown
                                                                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ansi-colors)
                                                                                                      • HTML
                                                                                                        <a href="https://www.jsdocs.io/package/ansi-colors"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>