sgr-composer 3.0.1 | Documentation

Usage

Installation

npm install --save sgr-composer

Examples

import SGRcomposer from 'sgr-composer'

API

SGRColor

src/index.js

A representation of an in/out SGR code pair.

SGRColor

Type: object

Properties

in (string) : The opening SGR color code.

out (string) : The closing SGR code.

style

src/index.js

Style declaration

style

Type: object

Properties

background (boolean) : Set background color

bold (boolean) : Set bold

dim (boolean) : Set dim mode

italic (boolean) : Set italics

underline (boolean) : Set underline

blink (boolean) : Set blink

invert (boolean) : Set inverted video

setStyles → Object

src/index.js

Set a style object/

setStyles(styles: style, excluded_: style) → Object

Parameters

styles (style) The style object to set

excluded_ (style) Styles to exclude.

Returns

Object: In and Out SGR parts

SGRcomposer

src/index.js

A Class for composing various SGR codes.

new SGRcomposer(targetDepth: (number | string), styles: style)

Type: SGRcomposer

Parameters

targetDepth ((number | string)) The target color depth.

styles (style) Additional SGR style codes.

Instance Members

▸ depth

src/index.js

Get the current color depth.

depth

Returns

number: 0: no color, 1: 16 colors, 2: 256 colors, 3: 16m colors

▸ color

src/index.js

Get the raw RGB color as an array.

color

Returns

Array<number>: An array of RGB elements

▸ color

src/index.js

Set the current color

color

Parameters

color (Array<number>) RGB as an array.

▸ hex

src/index.js

Get the raw color as a hex string.

hex

Returns

string: Color as hex string: #RRGGBB

▸ red

src/index.js

Get the red component.

red

Returns

number: Red component [0-255]

▸ green

src/index.js

Get the green component.

green

Returns

number: Green component [0-255]

▸ blue

src/index.js

Get the blue component.

blue

Returns

number: Blue component [0-255]

▸ style

src/index.js

Get the current style object

style

Returns

style: The currently set styles

▸ style

src/index.js

Set the current style

style

Parameters

styles ((style | array)) The desired styles as an object or array of keys.

▸ styleArray

src/index.js

Get the current style as an array of keys.

styleArray

Returns

Array<string>: An array of style keys.

▸ sgr(exclusions)

src/index.js

Render and SGRColor object.

sgr(exclusions: object) → SGRColor

Parameters

exclusions (object) Styles to exclude from render.

Returns

SGRColor: The rendered SGRColor object.