Home Reference Source Test Repository
public class | source

Colors

Represents an ANSI-escaped string.

Static Member Summary

Static Public Members
public static get

nice: *

installs String prototype extensions

Static Method Summary

Static Public Methods
public static

parse(s: *): Colors

parses a string containing ANSI escape codes

public static

strips ANSI codes from a string

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get
public get
public get

parsed: *

public

spans: *

public get

str: *

Method Summary

Public Methods
public

Static Public Members

public static get nice: * source

installs String prototype extensions

Example:

require ('ansicolor').nice
console.log ('foo'.bright.red)

Static Public Methods

public static parse(s: *): Colors source

parses a string containing ANSI escape codes

Params:

NameTypeAttributeDescription
s *

Return:

Colors

parsed representation.

public static strip(s: string): string source

strips ANSI codes from a string

Params:

NameTypeAttributeDescription
s string

a string containing ANSI escape codes.

Return:

string

clean string.

Public Constructors

public constructor(s: string) source

Params:

NameTypeAttributeDescription
s string

a string containing ANSI escape codes.

Public Members

public get asChromeConsoleLogArguments: undefined[] source

public get browserConsoleArguments: * source

public get parsed: * source

public spans: * source

public get str: * source

Public Methods

public [Symbol.iterator](): * source

Return:

*

Example:

const spans = [...ansi.parse ('\u001b[7m\u001b[7mfoo\u001b[7mbar\u001b[27m')]