ValidationError
Constructors
commandMismatch
Added in v1.0.0
Source
Signature
declare const commandMismatch: (error: HelpDoc) => ValidationError;correctedFlag
Added in v1.0.0
Source
Signature
declare const correctedFlag: (error: HelpDoc) => ValidationError;helpRequested
Added in v1.0.0
Source
Signature
declare const helpRequested: <A>(command: Command<A>) => ValidationError;invalidArgument
Added in v1.0.0
Source
Signature
declare const invalidArgument: (error: HelpDoc) => ValidationError;invalidValue
Added in v1.0.0
Source
Signature
declare const invalidValue: (error: HelpDoc) => ValidationError;keyValuesDetected
Added in v1.0.0
Source
Signature
declare const keyValuesDetected: (
error: HelpDoc,
keyValues: ReadonlyArray<string>,
) => ValidationError;missingFlag
Added in v1.0.0
Source
Signature
declare const missingFlag: (error: HelpDoc) => ValidationError;missingSubcommand
Added in v1.0.0
Source
Signature
declare const missingSubcommand: (error: HelpDoc) => ValidationError;missingValue
Added in v1.0.0
Source
Signature
declare const missingValue: (error: HelpDoc) => ValidationError;noBuiltInMatch
Added in v1.0.0
Source
Signature
declare const noBuiltInMatch: (error: HelpDoc) => ValidationError;unclusteredFlag
Added in v1.0.0
Source
Signature
declare const unclusteredFlag: (
error: HelpDoc,
unclustered: ReadonlyArray<string>,
rest: ReadonlyArray<string>,
) => ValidationError;Models
CommandMismatch interface
Added in v1.0.0
Source
Signature
interface CommandMismatch extends Proto {
readonly _tag: "CommandMismatch";
readonly error: HelpDoc;
}CorrectedFlag interface
Added in v1.0.0
Source
Signature
interface CorrectedFlag extends Proto {
readonly _tag: "CorrectedFlag";
readonly error: HelpDoc;
}HelpRequested interface
Added in v1.0.0
Source
Signature
interface HelpRequested extends Proto {
readonly _tag: "HelpRequested";
readonly command: Command<unknown>;
readonly error: HelpDoc;
}InvalidArgument interface
Added in v1.0.0
Source
Signature
interface InvalidArgument extends Proto {
readonly _tag: "InvalidArgument";
readonly error: HelpDoc;
}InvalidValue interface
Added in v1.0.0
Source
Signature
interface InvalidValue extends Proto {
readonly _tag: "InvalidValue";
readonly error: HelpDoc;
}MissingFlag interface
Added in v1.0.0
Source
Signature
interface MissingFlag extends Proto {
readonly _tag: "MissingFlag";
readonly error: HelpDoc;
}MissingSubcommand interface
Added in v1.0.0
Source
Signature
interface MissingSubcommand extends Proto {
readonly _tag: "MissingSubcommand";
readonly error: HelpDoc;
}MissingValue interface
Added in v1.0.0
Source
Signature
interface MissingValue extends Proto {
readonly _tag: "MissingValue";
readonly error: HelpDoc;
}MultipleValuesDetected interface
Added in v1.0.0
Source
Signature
interface MultipleValuesDetected extends Proto {
readonly _tag: "MultipleValuesDetected";
readonly error: HelpDoc;
readonly values: readonly Array<string>;
}NoBuiltInMatch interface
Added in v1.0.0
Source
Signature
interface NoBuiltInMatch extends Proto {
readonly _tag: "NoBuiltInMatch";
readonly error: HelpDoc;
}UnclusteredFlag interface
Added in v1.0.0
Source
Signature
interface UnclusteredFlag extends Proto {
readonly _tag: "UnclusteredFlag";
readonly error: HelpDoc;
readonly rest: readonly Array<string>;
readonly unclustered: readonly Array<string>;
}ValidationError type
Added in v1.0.0
Source
Signature
type ValidationError =
| CommandMismatch
| CorrectedFlag
| HelpRequested
| InvalidArgument
| InvalidValue
| MissingValue
| MissingFlag
| MultipleValuesDetected
| MissingSubcommand
| NoBuiltInMatch
| UnclusteredFlag;Other
ValidationError
Added in v1.0.0
Source
Refinements
isCommandMismatch
Added in v1.0.0
Source
Signature
declare const isCommandMismatch: (self: ValidationError) => self is CommandMismatch;isCorrectedFlag
Added in v1.0.0
Source
Signature
declare const isCorrectedFlag: (self: ValidationError) => self is CorrectedFlag;isHelpRequested
Added in v1.0.0
Source
Signature
declare const isHelpRequested: (self: ValidationError) => self is HelpRequested;isInvalidArgument
Added in v1.0.0
Source
Signature
declare const isInvalidArgument: (self: ValidationError) => self is InvalidArgument;isInvalidValue
Added in v1.0.0
Source
Signature
declare const isInvalidValue: (self: ValidationError) => self is InvalidValue;isMissingFlag
Added in v1.0.0
Source
Signature
declare const isMissingFlag: (self: ValidationError) => self is MissingFlag;isMissingSubcommand
Added in v1.0.0
Source
Signature
declare const isMissingSubcommand: (self: ValidationError) => self is MissingSubcommand;isMissingValue
Added in v1.0.0
Source
Signature
declare const isMissingValue: (self: ValidationError) => self is MissingValue;isMultipleValuesDetected
Added in v1.0.0
Source
Signature
declare const isMultipleValuesDetected: (self: ValidationError) => self is MultipleValuesDetected;isNoBuiltInMatch
Added in v1.0.0
Source
Signature
declare const isNoBuiltInMatch: (self: ValidationError) => self is NoBuiltInMatch;isUnclusteredFlag
Added in v1.0.0
Source
Signature
declare const isUnclusteredFlag: (self: ValidationError) => self is UnclusteredFlag;isValidationError
Added in v1.0.0
Source
Signature
declare const isValidationError: (u: unknown) => u is ValidationError;Symbols
ValidationErrorTypeId
Added in v1.0.0
Source
Signature
declare const ValidationErrorTypeId: unique symbol;ValidationErrorTypeId type
Added in v1.0.0
Source
Signature
type ValidationErrorTypeId = typeof ValidationErrorTypeId;