Skip to content

assert

Import from @varavel/vdl-plugin-sdk.

function assert(
   condition, 
   message, 
   position?): asserts condition;

Ensures condition is truthy, otherwise throws a PluginError.

The asserts condition return type enables TypeScript narrowing in plugin code after this function returns.

Parameters

Parameter Type Description
condition unknown Condition that must hold.
message string Diagnostic message when the condition fails.
position? Position Optional source location for precise diagnostics.

Returns

asserts condition