VDL Plugin SDK

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

ParameterTypeDescription
conditionunknownCondition that must hold.
messagestringDiagnostic message when the condition fails.
position?PositionOptional source location for precise diagnostics.

Returns

asserts condition