Skip to content

validate() function

Home > streplts > validate

Asserts structural grammar validation, verifying sub-namespaces and ensuring all required parameters are specified.

Signature:

export declare function validate(input: string, registry: Registry): {
ok: boolean;
unknownCmd?: string;
needsSubcmd?: boolean;
name?: string;
missingArgs?: string[];
};

Parameter

Type

Description

input

string

The raw statement line string intended for execution.

registry

Registry

Hierarchical routing definitions tree.

Returns:

{ ok: boolean; unknownCmd?: string; needsSubcmd?: boolean; name?: string; missingArgs?: string[]; }

Status validation diagnostic object. *