Skip to content

ValidationError

38 exports Added in v1.0.0 Source

Constructors

Signature

declare const commandMismatch: (error: HelpDoc) => ValidationError;

Signature

declare const correctedFlag: (error: HelpDoc) => ValidationError;

Signature

declare const helpRequested: <A>(command: Command<A>) => ValidationError;

Signature

declare const invalidArgument: (error: HelpDoc) => ValidationError;

invalidValue

Added in v1.0.0 Source

Signature

declare const invalidValue: (error: HelpDoc) => ValidationError;

Signature

declare const keyValuesDetected: (
  error: HelpDoc,
  keyValues: ReadonlyArray<string>,
) => ValidationError;

missingFlag

Added in v1.0.0 Source

Signature

declare const missingFlag: (error: HelpDoc) => ValidationError;

Signature

declare const missingSubcommand: (error: HelpDoc) => ValidationError;

missingValue

Added in v1.0.0 Source

Signature

declare const missingValue: (error: HelpDoc) => ValidationError;

Signature

declare const noBuiltInMatch: (error: HelpDoc) => ValidationError;

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

Refinements

Signature

declare const isCommandMismatch: (self: ValidationError) => self is CommandMismatch;

Signature

declare const isCorrectedFlag: (self: ValidationError) => self is CorrectedFlag;

Signature

declare const isHelpRequested: (self: ValidationError) => self is HelpRequested;

Signature

declare const isInvalidArgument: (self: ValidationError) => self is InvalidArgument;

Signature

declare const isInvalidValue: (self: ValidationError) => self is InvalidValue;

Signature

declare const isMissingFlag: (self: ValidationError) => self is MissingFlag;

Signature

declare const isMissingSubcommand: (self: ValidationError) => self is MissingSubcommand;

Signature

declare const isMissingValue: (self: ValidationError) => self is MissingValue;

Signature

declare const isMultipleValuesDetected: (self: ValidationError) => self is MultipleValuesDetected;

Signature

declare const isNoBuiltInMatch: (self: ValidationError) => self is NoBuiltInMatch;

Signature

declare const isUnclusteredFlag: (self: ValidationError) => self is UnclusteredFlag;

Signature

declare const isValidationError: (u: unknown) => u is ValidationError;

Symbols

Signature

declare const ValidationErrorTypeId: unique symbol;

Signature

type ValidationErrorTypeId = typeof ValidationErrorTypeId;