ThreeBitColor.ts overview

This module defines ThreeBit colors

Exports Grouped by Category

• Constructors
  • make
  • makeBright
• Equivalences
  • equivalence
• Getters
  • isBright
  • offset
• Instances
  • black
  • blue
  • brightBlack
  • brightBlue
  • brightCyan
  • brightGreen
  • brightMagenta
  • brightRed
  • brightWhite
  • brightYellow
  • cyan
  • green
  • magenta
  • red
  • white
  • yellow
• Models
  • Type (class)
    • make (static method)
    • [Hash.symbol] (method)
    • [MEquivalenceBasedEqualityData.isEquivalentToSymbol] (method)
    • [MEquivalenceBasedEqualityData.hasSameTypeMarkerAsSymbol] (method)
    • offset (property)
    • isBright (property)
• Module markers
  • moduleTag

Constructors

make

Constructor of normal colors

Signature

declare const make: (offset: ASThreeBitColorOffset.Type) => Type

Source

makeBright

Constructor of bright colors

Signature

declare const makeBright: (offset: ASThreeBitColorOffset.Type) => Type

Source

Equivalences

equivalence

Equivalence

Signature

declare const equivalence: Equivalence.Equivalence<Type>

Source

Getters

isBright

Gets the isBright property of self

Signature

declare const isBright: MTypes.OneArgFunction<Type, boolean>

Source

offset

Gets the offset property of self

Signature

declare const offset: MTypes.OneArgFunction<Type, ASThreeBitColorOffset.Type>

Source

Instances

black

Original Black color instance

Signature

declare const black: Type

Source

blue

Original Blue color instance

Signature

declare const blue: Type

Source

brightBlack

Original Bright Black color instance

Signature

declare const brightBlack: Type

Source

brightBlue

Original Bright Blue color instance

Signature

declare const brightBlue: Type

Source

brightCyan

Original Bright Cyan color instance

Signature

declare const brightCyan: Type

Source

brightGreen

Original Bright Green color instance

Signature

declare const brightGreen: Type

Source

brightMagenta

Original Bright Magenta color instance

Signature

declare const brightMagenta: Type

Source

brightRed

Original Bright Red color instance

Signature

declare const brightRed: Type

Source

brightWhite

Original Bright White color instance

Signature

declare const brightWhite: Type

Source

brightYellow

Original Bright Yellow color instance

Signature

declare const brightYellow: Type

Source

cyan

Original Cyan color instance

Signature

declare const cyan: Type

Source

green

Original Green color instance

Signature

declare const green: Type

Source

magenta

Original Magenta color instance

Signature

declare const magenta: Type

Source

red

Original Red color instance

Signature

declare const red: Type

Source

white

Original White color instance

Signature

declare const white: Type

Source

yellow

Original Yellow color instance

Signature

declare const yellow: Type

Source

Models

Type (class)

ThreeBitColor Type

Signature

declare class Type {
  private constructor({ offset, isBright }: { readonly offset: ASThreeBitColorOffset.Type; readonly isBright: boolean })
}

Source

make (static method)

Static constructor

Signature

declare const make: (params: { readonly offset: ASThreeBitColorOffset.Type; readonly isBright: boolean }) => Type

Source

[Hash.symbol] (method)

Calculates the hash value of this

Signature

declare const [Hash.symbol]: () => number

Source

[MEquivalenceBasedEqualityData.isEquivalentToSymbol] (method)

Function that implements the equivalence of this and that

Signature

declare const [MEquivalenceBasedEqualityData.isEquivalentToSymbol]: (this: this, that: this) => boolean

Source

[MEquivalenceBasedEqualityData.hasSameTypeMarkerAsSymbol] (method)

Predicate that returns true if that has the same type marker as this

Signature

declare const [MEquivalenceBasedEqualityData.hasSameTypeMarkerAsSymbol]: (that: unknown) => boolean

Source

offset (property)

Offset of this color

Signature

readonly offset: ASThreeBitColorOffset.Type

Source

isBright (property)

Indicates whether the color is bright

Signature

readonly isBright: boolean

Source

Module markers

moduleTag

Module tag

Signature

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

Source