Color overview

This module defines the abstract Color type, the base for all ANSI color kinds (ThreeBit, EightBit, and RGB)

Table of contents

• Destructors
  • toString
• Equivalences
  • equivalence
• Getters
  • backgroundId
  • backgroundSequence
  • foregroundId
  • foregroundSequence
• Models
  • Type (class)
    • [MData.idSymbol] (method)
    • foregroundId (property)
    • backgroundId (property)
    • foregroundSequence (property)
    • backgroundSequence (property)
• Module markers
  • moduleTag

Destructors

toString

Gets the id of self

Signature

export declare const toString: MTypes.OneArgFunction<Type, string>

Equivalences

equivalence

Equivalence

Signature

export declare const equivalence: Equivalence.Equivalence<Type>

Getters

backgroundId

Gets the background id of self

Signature

export declare const backgroundId: (self: Type) => string

backgroundSequence

Gets the background sequence of self

Signature

export declare const backgroundSequence: (self: Type) => ASSequence.OverOne

foregroundId

Gets the foreground id of self

Signature

export declare const foregroundId: (self: Type) => string

foregroundSequence

Gets the foreground sequence of self

Signature

export declare const foregroundSequence: (self: Type) => ASSequence.OverOne

Models

Type (class)

Color Type

Signature

export declare class Type {
  constructor({
    foregroundId,
    foregroundSequence
  }: {
    readonly foregroundId: string
    readonly foregroundSequence: ASSequence.OverOne
  })
}

[MData.idSymbol] (method)

Returns the id of this

Signature

[MData.idSymbol](): string | (() => string)

foregroundId (property)

Id of this color used as foreground color

Signature

readonly foregroundId: string

backgroundId (property)

Id of this color used as background color

Signature

readonly backgroundId: string

foregroundSequence (property)

Sequence of this color used as foreground color

Signature

readonly foregroundSequence: ASSequence.OverOne

backgroundSequence (property)

Sequence of this color used as background color

Signature

readonly backgroundSequence: ASSequence.OverOne

Module markers

moduleTag

Module tag

Signature

export declare const moduleTag: "@parischap/ansi-styles/Color/"