@function assert-equal($pExpected, $pValue, $pMessage: _equal_fail($pExpected), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function assert-unequal($pUnexpected, $pValue, $pMessage: _unequal_fail($pExpected), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function assert-true($pValue, $pMessage: "condition must be true", $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pCondition is returned.
2. If the assertion fails and the handler does not terminate, $pCondition is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function assert-false($pValue, $pMessage: "condition must be false", $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pCondition is returned.
2. If the assertion fails and the handler does not terminate, $pCondition is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function _equal_fail($pExpected) { ... }

String —

the final error message

@function _unequal_fail($pExpected) { ... }

String —

the final error message

@function default-throw-handler() { ... }

Function —

the handler function associated with 'exit'

@function check-is-empty($pIterableOrString, $pMessage: "must be empty", $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, given value is returned.
2. If the assertion fails and the handler does not terminate, given value is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-not-empty($pIterableOrString, $pMessage: "must not be empty", $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, given value is returned.
2. If the assertion fails and the handler does not terminate, given value is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-map($pValue, $pMessage: _generic_fail($pValue, "not a map"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-list($pValue, $pMessage: _generic_fail($pValue, "not a list"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-arglist($pValue, $pMessage: _generic_fail($pValue, "not an arglist"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-function($pValue, $pMessage: _generic_fail($pValue, "not a function"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-iterable($pValue, $pMessage: _generic_fail($pValue, "not an iterable"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-undefined($pValue, $pMessage: _generic_fail($pValue, "not undefined"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-primitive($pValue, $pMessage: _generic_fail($pValue, "not a primitive"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-string($pValue, $pMessage: _generic_fail($pValue, "not a string"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-number($pValue, $pMessage: _generic_fail($pValue, "not a number"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-color($pValue, $pMessage: _generic_fail($pValue, "not a color"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-bool($pValue, $pMessage: _generic_fail($pValue, "not a boolean"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-truthy($pValue, $pMessage: _generic_fail($pValue, "not truthy"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-falsy($pValue, $pMessage: _generic_fail($pValue, "not falsy"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-has-unit($pValue, $pUnitList, $pMessage: _has_unit_fail($pValue, $pUnitList), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-time($pValue, $pMessage: _generic_fail($pValue, "not a time"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-duration($pValue, $pMessage: _generic_fail($pValue, "not a duration"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-angle($pValue, $pMessage: _generic_fail($pValue, "not an angle"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-frequency($pValue, $pMessage: _generic_fail($pValue, "not a frequency"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-integer($pValue, $pMessage: _generic_fail($pValue, "not an integer"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-relative-length($pValue, $pMessage: _generic_fail($pValue, "not a relative length"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-absolute-length($pValue, $pMessage: _generic_fail($pValue, "not an absolute length"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-percentage($pValue, $pMessage: _generic_fail($pValue, "not a percentage"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-length($pValue, $pMessage: _generic_fail($pValue, "not a length"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-resolution($pValue, $pMessage: _generic_fail($pValue, "not a resolution"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function check-is-position($pValue, $pMessage: _generic_fail($pValue, "not a position"), $pHandler: default-throw-handler()) { ... }

Any type —

Returns conditionally.

1. If the assertion does not fail, $pValue is returned.
2. If the assertion fails and the handler does not terminate, $pValue is returned if the handler returns null. Otherwise, returns the handler's return value.
3. Returns never if the assertion fails and the handler terminates (as in stops the compilation).

@function throw-handlers() { ... }

Map —

the handler register map

@function throw-handler-exists($pHandlerName) { ... }

Boolean —

true if a handler with given name exists

@function throw-handler-get($pHandlerName) { ... }

Function —

the function associated with given name

@function throw-handler-add($pHandlerName, $pHandlerFunction) { ... }

String —

$pHandlerName if the operation succeeded

@function throw-handler-replace($pHandlerName, $pHandlerFunction) { ... }

String —

$pHandlerName if the operation succeeded

@function throw-invoke($pHandler, $vaArgs...) { ... }

Any type —

the result of the handler function call

@function throw-exit-handler() { ... }

Function —

the exit handler function

@function throw-warn-handler() { ... }

Function —

the warn handler function

@function report-error($pMessage) { ... }

Never or Null —

never returns unless the at-error directive is disabled, which will trigger a warning and a null return

@function report-warn($pMessage, $pReturnValue: null) { ... }

Any type —

returns $pReturnValue

@function throw($pMessage, $pHandler: handlers.exit-handler(), $pIfNull: null) { ... }

Any type —

Returns conditionally.

1. Returns never if the used handler terminates the compilation.
2. If the handler does not terminate, $pIfNull is returned if the result of the handler invocation is null. Otherwise, returns the result of the invocation.

@function warn-throw($pMessage, $pIfNull: null) { ... }

Any type —

Returns conditionally.

1. Returns never if the used handler terminates the compilation.
2. If the handler does not terminate, $pIfNull is returned if the result of the handler invocation is null. Otherwise, returns the result of the invocation.

@function nonnull-or($pValue, $pIfNull) { ... }

Any type —

$pValue if not null, else $pIfNull

@function truthy-or($pValue, $pIfFalsy) { ... }

Any type —

$pValue if truthy, else $pIfFalsy

@function falsy-or($pValue, $pIfTruthy) { ... }

Any type —

$pValue if falsy, else $pIfTruthy

@function is-empty($pValue) { ... }

Boolean —

true if $pValue is empty

@function count($pIterableOrString, $pFallback) { ... }

Boolean —

the length of given value if possible, else $pFallback

@function is-map($pValue) { ... }

Boolean —

true if $pValue is a map

@function is-list($pValue) { ... }

Boolean —

true if $pValue is a list

@function is-arglist($pValue) { ... }

Boolean —

true if $pValue is an arglist

@function is-function($pValue) { ... }

Boolean —

true if $pValue is a function

@function is-iterable($pValue) { ... }

Boolean —

true if $pValue is an iterable

@function is-undefined($pValue) { ... }

Boolean —

true if $pValue is undefined

@function is-primitive($pValue) { ... }

Boolean —

true if $pValue is a primitive

@function is-string($pValue) { ... }

Boolean —

true if $pValue is a string

@function is-number($pValue) { ... }

Boolean —

true if $pValue is a number

@function is-color($pValue) { ... }

Boolean —

true if $pValue is a color

@function is-bool($pValue) { ... }

Boolean —

true if $pValue is a boolean

@function as-boolean($pValue) { ... }

Boolean —

true if $pValue is truthy

@function is-truthy($pValue) { ... }

Boolean —

true if $pValue is a extensively truthy

@function is-falsy($pValue) { ... }

Boolean —

true if $pValue is a extensively falsy

@function has-unit($pValue) { ... }

Boolean —

true if $pUnitList contains the unit of $Value

@function is-time($pValue) { ... }

Boolean —

true if $pValue is a time value

@function is-duration($pValue) { ... }

Boolean —

true if $pValue is a time value

@function is-angle($pValue) { ... }

Boolean —

true if $pValue is an angle value

@function is-frequency($pValue) { ... }

Boolean —

true if $pValue is a frequency value

@function is-integer($pValue) { ... }

Boolean —

true if $pValue is an integer

@function is-relative-length($pValue) { ... }

Boolean —

true if $pValue is a relative length

@function is-absolute-length($pValue) { ... }

Boolean —

true if $pValue is an absolute length

@function is-percentage($pValue) { ... }

Boolean —

true if $pValue is a percentage

@function is-length($pValue) { ... }

Boolean —

true if $pValue is a length value

@function is-resolution($pValue) { ... }

Boolean —

true if $pValue is a resolution

@function is-position($pValue) { ... }

Boolean —

true if $pValue is a position

@function unit-times() { ... }

List —

a list of all time units

@function unit-angles() { ... }

List —

a list of all angle units

@function unit-frequencies() { ... }

List —

a list of all angle units

@function unit-relative-lengths() { ... }

List —

a list of all relative length units

@function unit-absolute-lengths() { ... }

List —

a list of all absolute length units

@function unit-resolutions() { ... }

List —

a list of all resolution units

@function unit-positions() { ... }

List —

a list of all position units