Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.29 KB

ValidationError.md

File metadata and controls

34 lines (22 loc) · 1.29 KB

@jakubmazanec/args

Variable: ValidationError()

const ValidationError: (code, options?) => CustomError<"INVALID_COMMAND" | "MISSING_PARAMETER" | "INVALID_PARAMETER_DEFAULT_AND_CHOICES" | "INVALID_PARAMETER_ORDER" | "MISSING_OPTION" | "INVALID_OPTION_DEFAULT_AND_CHOICES" | "INVALID_OPTION_NAME" | "REPEATED_OPTION_NAME" | "INVALID_OPTION_ARITY" | "UNKNOWN_ERROR">

Defined in: args/source/ValidationError.ts:6

A subclass of Error that indicates a validation issue.

Parameters

code

"INVALID_COMMAND" | "MISSING_PARAMETER" | "INVALID_PARAMETER_DEFAULT_AND_CHOICES" | "INVALID_PARAMETER_ORDER" | "MISSING_OPTION" | "INVALID_OPTION_DEFAULT_AND_CHOICES" | "INVALID_OPTION_NAME" | "REPEATED_OPTION_NAME" | "INVALID_OPTION_ARITY"

options?

CustomErrorOptions

Returns

CustomError<"INVALID_COMMAND" | "MISSING_PARAMETER" | "INVALID_PARAMETER_DEFAULT_AND_CHOICES" | "INVALID_PARAMETER_ORDER" | "MISSING_OPTION" | "INVALID_OPTION_DEFAULT_AND_CHOICES" | "INVALID_OPTION_NAME" | "REPEATED_OPTION_NAME" | "INVALID_OPTION_ARITY" | "UNKNOWN_ERROR">