Constants

Constants exported from @blokdots/components.

#BLOKDOTS_SOCKET_IO_SERVER_DEFAULT_PORT

TypeScript

const BLOKDOTS_SOCKET_IO_SERVER_DEFAULT_PORT: 8777 = 8777;

#GLYPH_HEIGHT

TypeScript

const GLYPH_HEIGHT: 8 = 8;

#GLYPH_WIDTH

TypeScript

const GLYPH_WIDTH: 6 = 6;

#NOTE_HZ

TypeScript

const NOTE_HZ: Record<string, number>;

#OLED_HEIGHT

TypeScript

const OLED_HEIGHT: 64 = 64;

#OLED_WIDTH

TypeScript

const OLED_WIDTH: 128 = 128;

#utils

TypeScript

const utils: object;

#Type Declaration

#clamp

TypeScript

clamp: (value, min, max) => number;

Clamp a value between min and max bounds.

#Parameters

Parameter	Type	Description
value	number	Value to clamp
min	number	Minimum value
max	number	Maximum value

#Returns

number

Clamped value

#hexToRgb

TypeScript

hexToRgb: (hex) => [number, number, number] | null;

#Parameters

Parameter	Type
hex	string

#Returns

[number, number, number] | null

#invertValue

TypeScript

invertValue: (value, max) => number;

Invert a value relative to a maximum.

#Parameters

Parameter	Type	Description
value	number	Value to invert
max	number	Maximum value for inversion

#Returns

number

Inverted value

#mapValue

TypeScript

mapValue: (value, inMin, inMax, outMin, outMax, constrain) => number;

Map a value between from one value to the other.

#Parameters

Parameter	Type	Default value	Description
value	number	undefined	Value to clamp
inMin	number	undefined	Minimum value in
inMax	number	undefined	Maximum value in
outMin	number	undefined	Minimum value out
outMax	number	undefined	Maximum value out
constrain	boolean	true	if the value should be constrained (default = true)

#Returns

number

Mapped value

#rgbToHex

TypeScript

rgbToHex: (r, g, b) => string;

#Parameters

Parameter	Type
r	number
g	number
b	number

#Returns

string