ThreeBitColor overview
This module defines ThreeBit colors
Table of contents
Constructors
make
Constructor of normal colors
Signature
export declare const make: (offset: ASThreeBitColorOffset.Type) => Type
makeBright
Constructor of bright colors
Signature
export declare const makeBright: (offset: ASThreeBitColorOffset.Type) => Type
Equivalences
equivalence
Equivalence
Signature
export declare const equivalence: Equivalence.Equivalence<Type>
Getters
isBright
Gets the isBright property of self
Signature
export declare const isBright: MTypes.OneArgFunction<Type, boolean>
offset
Gets the offset property of self
Signature
export declare const offset: MTypes.OneArgFunction<Type, ASThreeBitColorOffset.Type>
Instances
black
Original Black color instance
Signature
export declare const black: Type
blue
Original Blue color instance
Signature
export declare const blue: Type
brightBlack
Original Bright Black color instance
Signature
export declare const brightBlack: Type
brightBlue
Original Bright Blue color instance
Signature
export declare const brightBlue: Type
brightCyan
Original Bright Cyan color instance
Signature
export declare const brightCyan: Type
brightGreen
Original Bright Green color instance
Signature
export declare const brightGreen: Type
brightMagenta
Original Bright Magenta color instance
Signature
export declare const brightMagenta: Type
brightRed
Original Bright Red color instance
Signature
export declare const brightRed: Type
brightWhite
Original Bright White color instance
Signature
export declare const brightWhite: Type
brightYellow
Original Bright Yellow color instance
Signature
export declare const brightYellow: Type
cyan
Original Cyan color instance
Signature
export declare const cyan: Type
green
Original Green color instance
Signature
export declare const green: Type
magenta
Original Magenta color instance
Signature
export declare const magenta: Type
red
Original Red color instance
Signature
export declare const red: Type
white
Original White color instance
Signature
export declare const white: Type
yellow
Original Yellow color instance
Signature
export declare const yellow: Type
Models
Type (class)
ThreeBitColor Type
Signature
export declare class Type {
private constructor({ offset, isBright }: { readonly offset: ASThreeBitColorOffset.Type; readonly isBright: boolean })
}
make (static method)
Static constructor
Signature
static make(params: {
readonly offset: ASThreeBitColorOffset.Type;
readonly isBright: boolean;
}): Type
[Hash.symbol] (method)
Calculates the hash value of this
Signature
[Hash.symbol](): number
[MEquivalenceBasedEqualityData.isEquivalentToSymbol] (method)
Function that implements the equivalence of this and that
Signature
[MEquivalenceBasedEqualityData.isEquivalentToSymbol](this: this, that: this): boolean
[MEquivalenceBasedEqualityData.hasSameTypeMarkerAsSymbol] (method)
Predicate that returns true if that has the same type marker as this
Signature
[MEquivalenceBasedEqualityData.hasSameTypeMarkerAsSymbol](that: unknown): boolean
offset (property)
Offset of this color
Signature
readonly offset: ASThreeBitColorOffset.Type
isBright (property)
Indicates whether the color is bright
Signature
readonly isBright: boolean
Module markers
moduleTag
Module tag
Signature
export declare const moduleTag: "@parischap/ansi-styles/Color/ThreeBitColor/"