Function: assert()

function assert<T>(
   condition: T, 
   format: string, ...
   rest: AnyArgs): asserts condition;

Assertion function to ensure provided condition is truthy. Raises a formatted error when the condition is falsy.

Type Parameters

Type Parameter	Default type
T	boolean

Parameters

Parameter	Type	Description
condition	T	Condition to assert.
format	string	C-like formatted string for interpolation.
...rest	AnyArgs	Rest parameters to interpolate into format string.

Returns

asserts condition

Remarks

@inline keeps the happy path as a local if check and avoids a function call at runtime.