Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IColurs

Hierarchy

Implemented by

Index

Properties

Optional bgBlack

bgBlack: IColursChain

Optional bgBlackBright

bgBlackBright: IColursChain

Optional bgBlue

bgBlue: IColursChain

Optional bgBlueBright

bgBlueBright: IColursChain

Optional bgCyan

bgCyan: IColursChain

Optional bgCyanBright

bgCyanBright: IColursChain

Optional bgGray

bgGray: IColursChain

Optional bgGreen

bgGreen: IColursChain

Optional bgGreenBright

bgGreenBright: IColursChain

Optional bgGrey

bgGrey: IColursChain

Optional bgMagenta

bgMagenta: IColursChain

Optional bgMagentaBright

bgMagentaBright: IColursChain

Optional bgRed

Optional bgRedBright

bgRedBright: IColursChain

Optional bgWhite

bgWhite: IColursChain

Optional bgWhiteBright

bgWhiteBright: IColursChain

Optional bgYellow

bgYellow: IColursChain

Optional bgYellowBright

bgYellowBright: IColursChain

Optional black

Optional blackBright

blackBright: IColursChain

Optional blue

Optional blueBright

blueBright: IColursChain

Optional bold

Optional cyan

Optional cyanBright

cyanBright: IColursChain

Optional dim

Optional gray

Optional green

Optional greenBright

greenBright: IColursChain

Optional grey

Optional hidden

hidden: IColursChain

Optional inverse

inverse: IColursChain

Optional italic

italic: IColursChain

Optional magenta

magenta: IColursChain

Optional magentaBright

magentaBright: IColursChain

Optional options

options: IColurOptions

Colurs options.

Optional red

Optional redBright

redBright: IColursChain

Optional reset

Optional strikethrough

strikethrough: IColursChain

Optional underline

underline: IColursChain

Optional white

Optional whiteBright

whiteBright: IColursChain

Optional yellow

yellow: IColursChain

Optional yellowBright

yellowBright: IColursChain

Methods

Optional applyAnsi

  • applyAnsi(str: string, style: any): string
  • applyAnsi(str: string, styles: any[]): string
  • applyAnsi(str: string, style: any, isBrowser: boolean): any[]
  • applyAnsi(str: string, styles: any[], isBrowser: boolean): any[]
  • applyAnsi(str: string, style: any | any[], isBrowser?: boolean): string | any[]
  • Apply ansi styling to value.

    example

    .applyAnsi('foo', 'red');

    Parameters

    • str: string

      the value to be styled.

    • style: any

      the style to be applied.

    Returns string

  • Apply ansi styling to value.

    example

    .applyAnsi('foo', ['red', 'bold']);

    Parameters

    • str: string

      the value to be styled.

    • styles: any[]

      the styles to be applied.

    Returns string

  • Apply ansi styling to value.

    example

    .applyAnsi('foo', 'red', true);

    Parameters

    • str: string

      the value to be styled.

    • style: any

      the style to be applied.

    • isBrowser: boolean

      allows override to style for browser.

    Returns any[]

  • Apply ansi styling to value.

    example

    .applyAnsi('foo', ['red', 'bold'], true);

    Parameters

    • str: string

      the value to be styled.

    • styles: any[]

      the styles to be applied.

    • isBrowser: boolean

      allows override to style for browser.

    Returns any[]

  • Parameters

    • str: string
    • style: any | any[]
    • Optional isBrowser: boolean

    Returns string | any[]

Optional applyCss

  • applyCss(str: string, style: string | string[]): any[]
  • Applies styling for css.

    Parameters

    • str: string

      the value to apply css styling to.

    • style: string | string[]

      the style or styles to apply.

    Returns any[]

Optional applyHtml

  • applyHtml(str: any, style: any | any[]): string
  • Applies styling for html output.

    Parameters

    • str: any

      the value to apply html styles to.

    • style: any | any[]

      the style or styles to be applied.

    Returns string

Optional browser

  • browser(state?: boolean): boolean
  • Toggles enable/disable of browser mode.

    Parameters

    • Optional state: boolean

      when true using browser mode.

    Returns boolean

Optional enabled

  • enabled(state?: boolean): boolean
  • Toggles state when false colorizing is disabled.

    Parameters

    • Optional state: boolean

      toggles the enabled state.

    Returns boolean

Optional hasAnsi

  • hasAnsi(val: any): boolean
  • Checks if value has any ansi styling.

    Parameters

    • val: any

      the value to inspect.

    Returns boolean

Optional setOption

  • setOption(key: any, val: any): void
  • Enables setting options after init.

    Parameters

    • key: any

      the key to set or object.

    • val: any

      the value to set if key is not an object.

    Returns void

Optional strip

  • strip(val: any): any
  • Strips ansi styles from value.

    Parameters

    • val: any

      the value to strip ansi styling from.

    Returns any

Optional toHtml

  • toHtml(str: string): string
  • Converts to html styling from ansi, simply a convenience wrapper to ansi-html module.

    Parameters

    • str: string

      the value to convert.

    Returns string

Generated using TypeDoc