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