RgbColor.ts overview

This module defines an RGB color. Use the make function to build custom RGB colors from red, green, and blue components (0-255).

Exports Grouped by Category

• Constructors
  • make
• Equivalences
  • equivalence
• Instances
  • aliceBlue
  • antiqueWhite
  • aqua
  • aquaMarine
  • azure
  • beige
  • bisque
  • black
  • blanchedAlmond
  • blue
  • blueViolet
  • brown
  • burlyWood
  • cadetBlue
  • chartreuse
  • chocolate
  • coral
  • cornFlowerBlue
  • cornSilk
  • crimson
  • cyan
  • darkBlue
  • darkCyan
  • darkGoldenRod
  • darkGray
  • darkGreen
  • darkKhaki
  • darkMagenta
  • darkOliveGreen
  • darkOrange
  • darkOrchid
  • darkRed
  • darkSalmon
  • darkSeaGreen
  • darkSlateBlue
  • darkSlateGray
  • darkTurquoise
  • darkViolet
  • deepPink
  • deepSkyBlue
  • dimGray
  • dodgerBlue
  • firebrick
  • floralWhite
  • forestGreen
  • gainsboro
  • ghostWhite
  • gold
  • goldenRod
  • gray
  • green
  • greenYellow
  • honeyDew
  • hotPink
  • indianRed
  • indigo
  • ivory
  • khaki
  • lavender
  • lavenderBlush
  • lawnGreen
  • lemonChiffon
  • lightBlue
  • lightCoral
  • lightCyan
  • lightGoldenRodYellow
  • lightGray
  • lightGreen
  • lightPink
  • lightSalmon
  • lightSeaGreen
  • lightSkyBlue
  • lightSlateGray
  • lightSteelBlue
  • lightYellow
  • lime
  • limeGreen
  • linen
  • magenta
  • maroon
  • mediumAquaMarine
  • mediumBlue
  • mediumOrchid2
  • mediumPurple
  • mediumSeaGreen
  • mediumSlateBlue
  • mediumSpringGreen
  • mediumTurquoise
  • mediumVioletRed
  • midnightBlue
  • mintCream
  • mistyRose
  • moccasin
  • navajoWhite
  • navy
  • oldLace
  • olive
  • oliveDrab
  • orange
  • orangeRed
  • orchid
  • paleGoldenRod
  • paleGreen
  • paleTurquoise
  • paleVioletRed
  • papayaWhip
  • peachPuff
  • peru
  • pink
  • plum
  • powderBlue
  • purple
  • red
  • rosyBrown
  • royalBlue
  • saddleBrown
  • salmon
  • sandyBrown
  • seaGreen
  • seaShell
  • sienna
  • silver
  • skyBlue
  • slateBlue
  • slateGray
  • snow
  • springGreen
  • steelBlue
  • tan
  • teal
  • thistle
  • tomato
  • turquoise
  • violet
  • wheat
  • white
  • whiteSmoke
  • yellow
  • yellowGreen
• Models
  • Type (class)
    • make (static method)
    • [Hash.symbol] (method)
    • [MEquivalenceBasedEqualityData.isEquivalentToSymbol] (method)
    • [MEquivalenceBasedEqualityData.hasSameTypeMarkerAsSymbol] (method)
    • red (property)
    • green (property)
    • blue (property)
• Module markers
  • moduleTag

Constructors

make

Constructor

Signature

declare const make: ({
  red,
  green,
  blue
}: {
  readonly red: number
  readonly green: number
  readonly blue: number
}) => Type

Source

Equivalences

equivalence

Equivalence

Signature

declare const equivalence: Equivalence.Equivalence<Type>

Source

Instances

aliceBlue

RGB AliceBlue Color instance

Signature

declare const aliceBlue: Type

Source

antiqueWhite

RGB AntiqueWhite Color instance

Signature

declare const antiqueWhite: Type

Source

aqua

RGB Aqua Color instance

Signature

declare const aqua: Type

Source

aquaMarine

RGB AquaMarine Color instance

Signature

declare const aquaMarine: Type

Source

azure

RGB Azure Color instance

Signature

declare const azure: Type

Source

beige

RGB Beige Color instance

Signature

declare const beige: Type

Source

bisque

RGB Bisque Color instance

Signature

declare const bisque: Type

Source

black

RGB Black Color instance

Signature

declare const black: Type

Source

blanchedAlmond

RGB BlanchedAlmond Color instance

Signature

declare const blanchedAlmond: Type

Source

blue

RGB Blue Color instance

Signature

declare const blue: Type

Source

blueViolet

RGB BlueViolet Color instance

Signature

declare const blueViolet: Type

Source

brown

RGB Brown Color instance

Signature

declare const brown: Type

Source

burlyWood

RGB BurlyWood Color instance

Signature

declare const burlyWood: Type

Source

cadetBlue

RGB CadetBlue Color instance

Signature

declare const cadetBlue: Type

Source

chartreuse

RGB Chartreuse Color instance

Signature

declare const chartreuse: Type

Source

chocolate

RGB Chocolate Color instance

Signature

declare const chocolate: Type

Source

coral

RGB Coral Color instance

Signature

declare const coral: Type

Source

cornFlowerBlue

RGB CornFlowerBlue Color instance

Signature

declare const cornFlowerBlue: Type

Source

cornSilk

RGB CornSilk Color instance

Signature

declare const cornSilk: Type

Source

crimson

RGB Crimson Color instance

Signature

declare const crimson: Type

Source

cyan

RGB Cyan Color instance

Signature

declare const cyan: Type

Source

darkBlue

RGB DarkBlue Color instance

Signature

declare const darkBlue: Type

Source

darkCyan

RGB DarkCyan Color instance

Signature

declare const darkCyan: Type

Source

darkGoldenRod

RGB DarkGoldenRod Color instance

Signature

declare const darkGoldenRod: Type

Source

darkGray

RGB DarkGray Color instance

Signature

declare const darkGray: Type

Source

darkGreen

RGB DarkGreen Color instance

Signature

declare const darkGreen: Type

Source

darkKhaki

RGB DarkKhaki Color instance

Signature

declare const darkKhaki: Type

Source

darkMagenta

RGB DarkMagenta Color instance

Signature

declare const darkMagenta: Type

Source

darkOliveGreen

RGB DarkOliveGreen Color instance

Signature

declare const darkOliveGreen: Type

Source

darkOrange

RGB DarkOrange Color instance

Signature

declare const darkOrange: Type

Source

darkOrchid

RGB DarkOrchid Color instance

Signature

declare const darkOrchid: Type

Source

darkRed

RGB DarkRed Color instance

Signature

declare const darkRed: Type

Source

darkSalmon

RGB DarkSalmon Color instance

Signature

declare const darkSalmon: Type

Source

darkSeaGreen

RGB DarkSeaGreen Color instance

Signature

declare const darkSeaGreen: Type

Source

darkSlateBlue

RGB DarkSlateBlue Color instance

Signature

declare const darkSlateBlue: Type

Source

darkSlateGray

RGB DarkSlateGray Color instance

Signature

declare const darkSlateGray: Type

Source

darkTurquoise

RGB DarkTurquoise Color instance

Signature

declare const darkTurquoise: Type

Source

darkViolet

RGB DarkViolet Color instance

Signature

declare const darkViolet: Type

Source

deepPink

RGB DeepPink Color instance

Signature

declare const deepPink: Type

Source

deepSkyBlue

RGB DeepSkyBlue Color instance

Signature

declare const deepSkyBlue: Type

Source

dimGray

RGB DimGray Color instance

Signature

declare const dimGray: Type

Source

dodgerBlue

RGB DodgerBlue Color instance

Signature

declare const dodgerBlue: Type

Source

firebrick

RGB Firebrick Color instance

Signature

declare const firebrick: Type

Source

floralWhite

RGB FloralWhite Color instance

Signature

declare const floralWhite: Type

Source

forestGreen

RGB ForestGreen Color instance

Signature

declare const forestGreen: Type

Source

gainsboro

RGB Gainsboro Color instance

Signature

declare const gainsboro: Type

Source

ghostWhite

RGB GhostWhite Color instance

Signature

declare const ghostWhite: Type

Source

gold

RGB Gold Color instance

Signature

declare const gold: Type

Source

goldenRod

RGB GoldenRod Color instance

Signature

declare const goldenRod: Type

Source

gray

RGB Gray Color instance

Signature

declare const gray: Type

Source

green

RGB Green Color instance

Signature

declare const green: Type

Source

greenYellow

RGB GreenYellow Color instance

Signature

declare const greenYellow: Type

Source

honeyDew

RGB HoneyDew Color instance

Signature

declare const honeyDew: Type

Source

hotPink

RGB HotPink Color instance

Signature

declare const hotPink: Type

Source

indianRed

RGB IndianRed Color instance

Signature

declare const indianRed: Type

Source

indigo

RGB Indigo Color instance

Signature

declare const indigo: Type

Source

ivory

RGB Ivory Color instance

Signature

declare const ivory: Type

Source

khaki

RGB Khaki Color instance

Signature

declare const khaki: Type

Source

lavender

RGB Lavender Color instance

Signature

declare const lavender: Type

Source

lavenderBlush

RGB LavenderBlush Color instance

Signature

declare const lavenderBlush: Type

Source

lawnGreen

RGB LawnGreen Color instance

Signature

declare const lawnGreen: Type

Source

lemonChiffon

RGB LemonChiffon Color instance

Signature

declare const lemonChiffon: Type

Source

lightBlue

RGB LightBlue Color instance

Signature

declare const lightBlue: Type

Source

lightCoral

RGB LightCoral Color instance

Signature

declare const lightCoral: Type

Source

lightCyan

RGB LightCyan Color instance

Signature

declare const lightCyan: Type

Source

lightGoldenRodYellow

RGB LightGoldenRodYellow Color instance

Signature

declare const lightGoldenRodYellow: Type

Source

lightGray

RGB LightGray Color instance

Signature

declare const lightGray: Type

Source

lightGreen

RGB LightGreen Color instance

Signature

declare const lightGreen: Type

Source

lightPink

RGB LightPink Color instance

Signature

declare const lightPink: Type

Source

lightSalmon

RGB LightSalmon Color instance

Signature

declare const lightSalmon: Type

Source

lightSeaGreen

RGB LightSeaGreen Color instance

Signature

declare const lightSeaGreen: Type

Source

lightSkyBlue

RGB LightSkyBlue Color instance

Signature

declare const lightSkyBlue: Type

Source

lightSlateGray

RGB LightSlateGray Color instance

Signature

declare const lightSlateGray: Type

Source

lightSteelBlue

RGB LightSteelBlue Color instance

Signature

declare const lightSteelBlue: Type

Source

lightYellow

RGB LightYellow Color instance

Signature

declare const lightYellow: Type

Source

lime

RGB Lime Color instance

Signature

declare const lime: Type

Source

limeGreen

RGB LimeGreen Color instance

Signature

declare const limeGreen: Type

Source

linen

RGB Linen Color instance

Signature

declare const linen: Type

Source

magenta

RGB Magenta Color instance

Signature

declare const magenta: Type

Source

maroon

RGB Maroon Color instance

Signature

declare const maroon: Type

Source

mediumAquaMarine

RGB MediumAquaMarine Color instance

Signature

declare const mediumAquaMarine: Type

Source

mediumBlue

RGB MediumBlue Color instance

Signature

declare const mediumBlue: Type

Source

mediumOrchid2

RGB MediumOrchid2 Color instance

Signature

declare const mediumOrchid2: Type

Source

mediumPurple

RGB MediumPurple Color instance

Signature

declare const mediumPurple: Type

Source

mediumSeaGreen

RGB MediumSeaGreen Color instance

Signature

declare const mediumSeaGreen: Type

Source

mediumSlateBlue

RGB MediumSlateBlue Color instance

Signature

declare const mediumSlateBlue: Type

Source

mediumSpringGreen

RGB MediumSpringGreen Color instance

Signature

declare const mediumSpringGreen: Type

Source

mediumTurquoise

RGB MediumTurquoise Color instance

Signature

declare const mediumTurquoise: Type

Source

mediumVioletRed

RGB MediumVioletRed Color instance

Signature

declare const mediumVioletRed: Type

Source

midnightBlue

RGB MidnightBlue Color instance

Signature

declare const midnightBlue: Type

Source

mintCream

RGB MintCream Color instance

Signature

declare const mintCream: Type

Source

mistyRose

RGB MistyRose Color instance

Signature

declare const mistyRose: Type

Source

moccasin

RGB Moccasin Color instance

Signature

declare const moccasin: Type

Source

navajoWhite

RGB NavajoWhite Color instance

Signature

declare const navajoWhite: Type

Source

navy

RGB Navy Color instance

Signature

declare const navy: Type

Source

oldLace

RGB OldLace Color instance

Signature

declare const oldLace: Type

Source

olive

RGB Olive Color instance

Signature

declare const olive: Type

Source

oliveDrab

RGB OliveDrab Color instance

Signature

declare const oliveDrab: Type

Source

orange

RGB Orange Color instance

Signature

declare const orange: Type

Source

orangeRed

RGB OrangeRed Color instance

Signature

declare const orangeRed: Type

Source

orchid

RGB Orchid Color instance

Signature

declare const orchid: Type

Source

paleGoldenRod

RGB PaleGoldenRod Color instance

Signature

declare const paleGoldenRod: Type

Source

paleGreen

RGB PaleGreen Color instance

Signature

declare const paleGreen: Type

Source

paleTurquoise

RGB PaleTurquoise Color instance

Signature

declare const paleTurquoise: Type

Source

paleVioletRed

RGB PaleVioletRed Color instance

Signature

declare const paleVioletRed: Type

Source

papayaWhip

RGB PapayaWhip Color instance

Signature

declare const papayaWhip: Type

Source

peachPuff

RGB PeachPuff Color instance

Signature

declare const peachPuff: Type

Source

peru

RGB Peru Color instance

Signature

declare const peru: Type

Source

pink

RGB Pink Color instance

Signature

declare const pink: Type

Source

plum

RGB Plum Color instance

Signature

declare const plum: Type

Source

powderBlue

RGB PowderBlue Color instance

Signature

declare const powderBlue: Type

Source

purple

RGB Purple Color instance

Signature

declare const purple: Type

Source

red

RGB Red Color instance

Signature

declare const red: Type

Source

rosyBrown

RGB RosyBrown Color instance

Signature

declare const rosyBrown: Type

Source

royalBlue

RGB RoyalBlue Color instance

Signature

declare const royalBlue: Type

Source

saddleBrown

RGB SaddleBrown Color instance

Signature

declare const saddleBrown: Type

Source

salmon

RGB Salmon Color instance

Signature

declare const salmon: Type

Source

sandyBrown

RGB SandyBrown Color instance

Signature

declare const sandyBrown: Type

Source

seaGreen

RGB SeaGreen Color instance

Signature

declare const seaGreen: Type

Source

seaShell

RGB SeaShell Color instance

Signature

declare const seaShell: Type

Source

sienna

RGB Sienna Color instance

Signature

declare const sienna: Type

Source

silver

RGB Silver Color instance

Signature

declare const silver: Type

Source

skyBlue

RGB SkyBlue Color instance

Signature

declare const skyBlue: Type

Source

slateBlue

RGB SlateBlue Color instance

Signature

declare const slateBlue: Type

Source

slateGray

RGB SlateGray Color instance

Signature

declare const slateGray: Type

Source

snow

RGB Snow Color instance

Signature

declare const snow: Type

Source

springGreen

RGB SpringGreen Color instance

Signature

declare const springGreen: Type

Source

steelBlue

RGB SteelBlue Color instance

Signature

declare const steelBlue: Type

Source

tan

RGB Tan Color instance

Signature

declare const tan: Type

Source

teal

RGB Teal Color instance

Signature

declare const teal: Type

Source

thistle

RGB Thistle Color instance

Signature

declare const thistle: Type

Source

tomato

RGB Tomato Color instance

Signature

declare const tomato: Type

Source

turquoise

RGB Turquoise Color instance

Signature

declare const turquoise: Type

Source

violet

RGB Violet Color instance

Signature

declare const violet: Type

Source

wheat

RGB Wheat Color instance

Signature

declare const wheat: Type

Source

white

RGB White Color instance

Signature

declare const white: Type

Source

whiteSmoke

RGB WhiteSmoke Color instance

Signature

declare const whiteSmoke: Type

Source

yellow

RGB Yellow Color instance

Signature

declare const yellow: Type

Source

yellowGreen

RGB YellowGreen Color instance

Signature

declare const yellowGreen: Type

Source

Models

Type (class)

RGB color Type

Signature

declare class Type {
  private constructor({
    foregroundId,
    red,
    green,
    blue
  }: {
    readonly foregroundId: string
    readonly red: number
    readonly green: number
    readonly blue: number
  })
}

Source

make (static method)

Static constructor

Signature

declare const make: (params: {
  readonly foregroundId: string
  readonly red: number
  readonly green: number
  readonly blue: number
}) => 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

red (property)

Red part of this color

Signature

readonly red: number

Source

green (property)

Green part of this color

Signature

readonly green: number

Source

blue (property)

Blue part of this color

Signature

readonly blue: number

Source

Module markers

moduleTag

Module tag

Signature

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

Source