Class Attributes

SGR Attributes

Implements

GenericBitfield<Attributes, number, Attribute | IntroducerAttribute>

Constructors

constructor

new Attributes(
    low?: number,
    high?: number,
    bg?: number,
    fg?: number,
    ul?: number,
    us?: UnderlineStyle,
): Attributes
Parameters
- Optionallow: number
- Optionalhigh: number
- Optionalbg: number
- Optionalfg: number
- Optionalul: number
- Optionalus: UnderlineStyle
Returns Attributes
- Defined in src/sgr/attributes.ts:191

Properties

`Readonly`bg

bg: number

`Readonly`fg

fg: number

`Protected` `Readonly`high

high: number

`Protected` `Readonly`low

low: number

`Readonly`ul

ul: number

`Readonly`us

us: UnderlineStyle

Accessors

length

get length(): number
Returns number
Implementation of GenericBitfield.length
- Defined in src/sgr/attributes.ts:747

Methods

[iterator]

"[iterator]"(): Generator<Attribute, void, unknown>
Returns Generator<Attribute, void, unknown>
Implementation of GenericBitfield.[iterator]
- Defined in src/sgr/attributes.ts:908

and

and(other: Attributes): Attributes
Parameters
- other: Attributes
Returns Attributes
Implementation of GenericBitfield.and
- Defined in src/sgr/attributes.ts:770

backgroundColor

backgroundColor(color: number): Attributes
Sets background color.
Parameters
- color: number
  basic, indexed or (packed) RGB color
Returns Attributes
- Defined in src/sgr/attributes.ts:474

blink

blink(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:295

bold

bold(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:230

clear

clear(): Attributes
Returns Attributes
Implementation of GenericBitfield.clear
- Defined in src/sgr/attributes.ts:732

conceal

conceal(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:336

copy

copy(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:897

curlyUnderline

curlyUnderline(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:631

dashedUnderline

dashedUnderline(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:639

defaultBackgroundColor

defaultBackgroundColor(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:565

defaultForegroundColor

defaultForegroundColor(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:459

defaultUnderlineColor

defaultUnderlineColor(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:609

dottedUnderline

dottedUnderline(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:635

doubleUnderline

doubleUnderline(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:627

entries

entries(): Generator<readonly [Bit, Attribute], void, unknown>
Returns Generator<readonly [Bit, Attribute], void, unknown>
- Defined in src/sgr/attributes.ts:941

faint

faint(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:241

foregroundColor

foregroundColor(color: number): Attributes
Sets foreground color.
Parameters
- color: number
  basic, indexed or (packed) RGB color
Returns Attributes
- Defined in src/sgr/attributes.ts:368

has

has(bit: number): boolean
Check if a bit is set at the specified position
Parameters
- bit: number
  The bit position (0-63)
Returns boolean
true if the bit is set, false otherwise
Implementation of GenericBitfield.has
- Defined in src/sgr/attributes.ts:705

isEmpty

isEmpty(): boolean
Returns boolean
Implementation of GenericBitfield.isEmpty
- Defined in src/sgr/attributes.ts:796

isFull

isFull(): boolean
Returns boolean
Implementation of GenericBitfield.isFull
- Defined in src/sgr/attributes.ts:807

italic

italic(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:248

keys

keys(): Generator<Bit, void, unknown>
An iterator of all keys (bit positions) in the bitfield

Returns Generator<Bit, void, unknown>
Implementation of GenericBitfield.keys
- Defined in src/sgr/attributes.ts:912

noBlink

noBlink(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:302

noConceal

noConceal(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:343

noItalic

noItalic(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:255

noReverse

noReverse(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:330

normalIntensity

normalIntensity(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:234

noStrikethrough

noStrikethrough(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:356

not

not(): Attributes
Returns Attributes
Implementation of GenericBitfield.not
- Defined in src/sgr/attributes.ts:792

noUnderline

noUnderline(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:284

or

or(other: Attributes): Attributes
Parameters
- other: Attributes
Returns Attributes
Implementation of GenericBitfield.or
- Defined in src/sgr/attributes.ts:759

rapidBlink

rapidBlink(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:316

reset

reset(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:226

reverse

reverse(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:323

set

set(
    bit: number,
    bg?: number,
    fg?: number,
    ul?: number,
    us?: UnderlineStyle,
): Attributes
Set a bit at the specified position
Parameters
- bit: number
  The bit position (0-63)
- Optionalbg: number
  background color
- Optionalfg: number
  foreground color
- Optionalul: number
  underline color
- Optionalus: UnderlineStyle
  underline style
Returns Attributes
A new Attributes instance with the bit set
Implementation of GenericBitfield.set
- Defined in src/sgr/attributes.ts:652

singleUnderline

singleUnderline(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:623

slowBlink

slowBlink(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:309

strikethrough

strikethrough(): Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:349

toggle

toggle(bit: number): Attributes
Toggle a bit at the specified position
Parameters
- bit: number
  The bit position (0-63)
Returns Attributes
A new Attributes instance with the bit toggled
Implementation of GenericBitfield.toggle
- Defined in src/sgr/attributes.ts:720

toHex

toHex(): string
Returns string
- Defined in src/sgr/attributes.ts:893

toJSON

toJSON(): bigint[]
Returns bigint[]
- Defined in src/sgr/attributes.ts:947

toString

toString(radix?: number): string
Parameters
- Optionalradix: number
Returns string
Implementation of GenericBitfield.toString
- Defined in src/sgr/attributes.ts:736

underline

underline(style?: UnderlineStyle): Attributes
Parameters
- style: UnderlineStyle = UnderlineStyle.Single
Returns Attributes
- Defined in src/sgr/attributes.ts:262

underlineColor

underlineColor(color: number): Attributes
Sets underline color.
Parameters
- color: number
  basic, indexed or (packed) RGB color
Returns Attributes
- Defined in src/sgr/attributes.ts:574

underlineStyle

underlineStyle(style: UnderlineStyle): Attributes
Parameters
- style: UnderlineStyle
Returns Attributes
- Defined in src/sgr/attributes.ts:619

unset

unset(
    bit: number,
    bg?: number,
    fg?: number,
    ul?: number,
    us?: UnderlineStyle,
): Attributes
Unset a bit at the specified position
Parameters
- bit: number
  The bit position (0-63)
- Optionalbg: number
  background color
- Optionalfg: number
  foreground color
- Optionalul: number
  underline color
- Optionalus: UnderlineStyle
  underline style
Returns Attributes
A new Attributes instance with the bit unset
Implementation of GenericBitfield.unset
- Defined in src/sgr/attributes.ts:677

valueOf

valueOf(): bigint
Returns bigint
Implementation of GenericBitfield.valueOf
- Defined in src/sgr/attributes.ts:741

values

values(): Generator<Attribute, void, unknown>
An iterator of all values in the bitfield

Returns Generator<Attribute, void, unknown>
Implementation of GenericBitfield.values
- Defined in src/sgr/attributes.ts:935

`Protected`with

with(
    low?: number,
    high?: number,
    bg?: number,
    fg?: number,
    ul?: number,
    us?: UnderlineStyle,
): Attributes
Parameters
- Optionallow: number
- Optionalhigh: number
- Optionalbg: number
- Optionalfg: number
- Optionalul: number
- Optionalus: UnderlineStyle
Returns Attributes
- Defined in src/sgr/attributes.ts:208

xor

xor(other: Attributes): Attributes
Parameters
- other: Attributes
Returns Attributes
Implementation of GenericBitfield.xor
- Defined in src/sgr/attributes.ts:781

`Static`and

and(a: Attributes, b: Attributes): Attributes
Parameters
- a: Attributes
- b: Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:867

`Static`assert

assert(bit: number): void
Parameters
- bit: number
Returns void
- Defined in src/sgr/attributes.ts:951

`Static`from

from(
    bigInt: bigint,
    bg?: number,
    fg?: number,
    ul?: number,
    us?: number,
): Attributes
Parameters
- bigInt: bigint
- Optionalbg: number
- Optionalfg: number
- Optionalul: number
- Optionalus: number
Returns Attributes
- Defined in src/sgr/attributes.ts:811
from(
    bits: number[],
    bg?: number,
    fg?: number,
    ul?: number,
    us?: UnderlineStyle,
): Attributes
Parameters
- bits: number[]
- Optionalbg: number
- Optionalfg: number
- Optionalul: number
- Optionalus: UnderlineStyle
Returns Attributes
- Defined in src/sgr/attributes.ts:818

`Static`not

not(a: Attributes): Attributes
Parameters
- a: Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:889

`Static`or

or(a: Attributes, b: Attributes): Attributes
Parameters
- a: Attributes
- b: Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:856

`Static`pack

pack(r: number, g: number, b: number): number
Parameters
- r: number
- g: number
- b: number
Returns number
- Defined in src/sgr/attributes.ts:956

`Static`unpack

unpack(rgb: number): number[]
Parameters
- rgb: number
Returns number[]
- Defined in src/sgr/attributes.ts:960

`Static`xor

xor(a: Attributes, b: Attributes): Attributes
Parameters
- a: Attributes
- b: Attributes
Returns Attributes
- Defined in src/sgr/attributes.ts:878