quark-utils

0.0.0-development
Need help reading this?

assert

Check if an expression is true

assert(expression: boolean, message: string)
Parameters
expression (boolean) Expression
message (string = 'AssertError') Message if expression is false
Throws
  • AssertError: Thrown if expression is false

assert

assert

equal

Check if actual value is equal to expected value

equal(actual: any, expected: any, message: string)
Parameters
actual (any) Actual value
expected (any) Expected value
message (string) Message if not equal
Throws
  • Error: Thrown if assertion is not equal assertion

falsy

Check if actual value is falsy

falsy(expression: boolean, message: string)
Parameters
expression (boolean) Expression
message (string) Message if expression is true
Throws
  • Error: Thrown if assertion is not equal assertion

assert.truthy

assert.truthy()

assert.notOk

assert.notOk()

notEqual

Check if actual value is not equal to expected value

notEqual(actual: any, expected: any, message: string)
Parameters
actual (any) Actual value
expected (any) Expected value
message (string) Message if equal assertion
Throws
  • Error: Thrown if assertion is equal

getURLFileExtension

Get URL file extension

getURLFileExtension(url: string): string
Parameters
url (string) URL
Returns
string: File extension

common

common

isArray

Check if value is an Array

isArray(val: any): boolean
Parameters
val (any) Value
Returns
boolean: True if value is an Array, false otherwise

isCorsSupported

Check if CORS (Cross-origin resource sharing) is supported

isCorsSupported(): boolean
Returns
boolean: True if CORS is supported, false otherwise

isObject

Check if value is an Object

isObject(val: any): boolean
Parameters
val (any) Value
Returns
boolean: True if value is an Object, false otherwise

uuid

Generate a UUID (Universal Unique Identifier). Format : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

uuid()

createCanvas

Create a canvas element

createCanvas(width: number, height: number): HTMLCanvasElement
Parameters
width (number = window.innerWidth) Width
height (number = window.innerHeight) Height
Returns
HTMLCanvasElement: Canvas element

getType

Get the type of an object

getType(obj: object): string
Parameters
obj (object) Object
Returns
string: Type of the object

dom

dom

isElement

Check if value is a HTML element

isElement(val: any): boolean
Parameters
val (any) Value
Returns
boolean: True if value is a HTMLElement, false otherwise

isMediaElement

Check if value is a HTML media element (image, audio or video)

isMediaElement(val: any): boolean
Parameters
val (any) Value
Returns
boolean: True if value is a HTML media element, false otherwise

isNodeList

Check if value is a NodeList

isNodeList(val: any): boolean
Parameters
val (any) Value
Returns
boolean: True if value is a NodeList, false otherwise

clamp

Clamp a value between two bounds

clamp(val: number, min: number, max: number): number
Parameters
val (number) Value to clamp
min (number) Minimum boundary
max (number) Maximum boundary
Returns
number: Clamped value

clampNorm

Clamp a value between 0 and 1 (normalized)

clampNorm(val: number): number
Parameters
val (number) Value to clamp
Returns
number: Clamped value

diagonal

Diagonal of a rectangle

diagonal(w: number, h: number): number
Parameters
w (number) Width
h (number) Height
Returns
number: Diagonal length

distance

Distance between two points

distance(x1: number, y1: number, x2: number, y2: number): number
Parameters
x1 (number) X coord of the first point
y1 (number) Y coord of the first point
x2 (number) X coord of the second point
y2 (number) Y coord of the second point
Returns
number: Computed distance

math

math

math.degToRad

math.degToRad()

isEven

Check if a number is even

isEven(number: number): boolean
Parameters
number (number) Number
Returns
boolean: True if the given number is even, false otherwise

isOdd

Check if a number is odd

isOdd(number: number): boolean
Parameters
number (number) Number
Returns
boolean: True if the given number is odd, false otherwise

lerp

Linear interpolation between two values (lerping)

lerp(val: number, x: number, y: number): number
Parameters
val (number) Normalized value to interpolate between x and y
x (number) First value
y (number) Second value
Returns
number: Lerped value

lightenDarkenColor

Lighten or darken a color

lightenDarkenColor(col: string, amt: number): string
Parameters
col (string) Color in hexadecimal
amt (number = 0) Amount
Returns
string: Computed hexadecimal

map

Re-maps a number from one range to another

map(val: number, start1: number, stop1: number, start2: number, stop2: number): number
Parameters
val (number) The incoming value to be converted
start1 (number) Lower bound of the value's current range
stop1 (number) Upper bound of the value's current range
start2 (number) Lower bound of the value's target range
stop2 (number) Upper bound of the value's target range
Returns
number: Remapped number

modAbs

Modulo absolute a value based on a length

modAbs(val: number, length: number): number
Parameters
val (number) Value
length (number) Length
Returns
number: Modulated value

normalize

Normalize a value between two bounds

normalize(val: number, min: number, max: number): number
Parameters
val (number) Value to normalize
min (number) Minimum boundary
max (number) Maximum boundary
Returns
number: Normalized value

parabola

Remap the 0..1 interval into 0..1 parabola, such that corners are remaped to 0 and the center to 1 In other words, parabola(0) = parabola(1) = 0, and parabola(1/2) = 1

parabola(val: number, x: number): number
Parameters
val (number) Normalized value to map
x (number) Normalized coordinate on X axis
Returns
number: Normalized mapped value

randomFloat

Generate a random float

randomFloat(min: number, max: number, precision: number): number
Parameters
min (number) Minimum boundary
max (number) Maximum boundary
precision (number = 2) Precision
Returns
number: Generated float

randomHexColor

Generate a random hexadecimal color

randomHexColor(): string
Returns
string: Hexadecimal color

randomInt

Generate a random integer

randomInt(min: number, max: number): number
Parameters
min (number) Minimum boundary
max (number) Maximum boundary
Returns
number: Generated integer

smoothstep

Smooth a value using cubic Hermite interpolation

smoothstep(val: number, min: number, max: number): number
Parameters
val (number) Value to smooth
min (number) Minimum boundary
max (number) Maximum boundary
Returns
number: Normalized smoothed value

toRadians

Convert a degrees value into radians

toRadians(degrees: number): number
Parameters
degrees (number) Degrees
Returns
number: Radians