Thanks to visit codestin.com
Credit goes to effect-ts.github.io

Skip to main content Codestin Search App Codestin Search App Codestin Search App Codestin Search App Codestin Search App Codestin Search App

ValidationError.ts overview

Since v1.0.0


Exports Grouped by Category


constructors

commandMismatch

Signature

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

Source

Since v1.0.0

correctedFlag

Signature

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

Source

Since v1.0.0

helpRequested

Signature

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

Source

Since v1.0.0

invalidArgument

Signature

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

Source

Since v1.0.0

invalidValue

Signature

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

Source

Since v1.0.0

keyValuesDetected

Signature

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

Source

Since v1.0.0

missingFlag

Signature

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

Source

Since v1.0.0

missingSubcommand

Signature

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

Source

Since v1.0.0

missingValue

Signature

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

Source

Since v1.0.0

noBuiltInMatch

Signature

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

Source

Since v1.0.0

unclusteredFlag

Signature

declare const unclusteredFlag: (
  error: HelpDoc,
  unclustered: ReadonlyArray<string>,
  rest: ReadonlyArray<string>
) => ValidationError

Source

Since v1.0.0

models

CommandMismatch (interface)

Signature

export interface CommandMismatch extends ValidationError.Proto {
  readonly _tag: "CommandMismatch"
  readonly error: HelpDoc
}

Source

Since v1.0.0

CorrectedFlag (interface)

Signature

export interface CorrectedFlag extends ValidationError.Proto {
  readonly _tag: "CorrectedFlag"
  readonly error: HelpDoc
}

Source

Since v1.0.0

HelpRequested (interface)

Signature

export interface HelpRequested extends ValidationError.Proto {
  readonly _tag: "HelpRequested"
  readonly error: HelpDoc
  readonly command: Command<unknown>
}

Source

Since v1.0.0

InvalidArgument (interface)

Signature

export interface InvalidArgument extends ValidationError.Proto {
  readonly _tag: "InvalidArgument"
  readonly error: HelpDoc
}

Source

Since v1.0.0

InvalidValue (interface)

Signature

export interface InvalidValue extends ValidationError.Proto {
  readonly _tag: "InvalidValue"
  readonly error: HelpDoc
}

Source

Since v1.0.0

MissingFlag (interface)

Signature

export interface MissingFlag extends ValidationError.Proto {
  readonly _tag: "MissingFlag"
  readonly error: HelpDoc
}

Source

Since v1.0.0

MissingSubcommand (interface)

Signature

export interface MissingSubcommand extends ValidationError.Proto {
  readonly _tag: "MissingSubcommand"
  readonly error: HelpDoc
}

Source

Since v1.0.0

MissingValue (interface)

Signature

export interface MissingValue extends ValidationError.Proto {
  readonly _tag: "MissingValue"
  readonly error: HelpDoc
}

Source

Since v1.0.0

MultipleValuesDetected (interface)

Signature

export interface MultipleValuesDetected extends ValidationError.Proto {
  readonly _tag: "MultipleValuesDetected"
  readonly error: HelpDoc
  readonly values: ReadonlyArray<string>
}

Source

Since v1.0.0

NoBuiltInMatch (interface)

Signature

export interface NoBuiltInMatch extends ValidationError.Proto {
  readonly _tag: "NoBuiltInMatch"
  readonly error: HelpDoc
}

Source

Since v1.0.0

UnclusteredFlag (interface)

Signature

export interface UnclusteredFlag extends ValidationError.Proto {
  readonly _tag: "UnclusteredFlag"
  readonly error: HelpDoc
  readonly unclustered: ReadonlyArray<string>
  readonly rest: ReadonlyArray<string>
}

Source

Since v1.0.0

ValidationError (type alias)

Signature

type ValidationError =
  | CommandMismatch
  | CorrectedFlag
  | HelpRequested
  | InvalidArgument
  | InvalidValue
  | MissingValue
  | MissingFlag
  | MultipleValuesDetected
  | MissingSubcommand
  | NoBuiltInMatch
  | UnclusteredFlag

Source

Since v1.0.0

refinements

isCommandMismatch

Signature

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

Source

Since v1.0.0

isCorrectedFlag

Signature

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

Source

Since v1.0.0

isHelpRequested

Signature

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

Source

Since v1.0.0

isInvalidArgument

Signature

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

Source

Since v1.0.0

isInvalidValue

Signature

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

Source

Since v1.0.0

isMissingFlag

Signature

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

Source

Since v1.0.0

isMissingSubcommand

Signature

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

Source

Since v1.0.0

isMissingValue

Signature

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

Source

Since v1.0.0

isMultipleValuesDetected

Signature

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

Source

Since v1.0.0

isNoBuiltInMatch

Signature

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

Source

Since v1.0.0

isUnclusteredFlag

Signature

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

Source

Since v1.0.0

isValidationError

Signature

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

Source

Since v1.0.0

symbols

ValidationErrorTypeId

Signature

declare const ValidationErrorTypeId: unique symbol

Source

Since v1.0.0

ValidationErrorTypeId (type alias)

Signature

type ValidationErrorTypeId = typeof ValidationErrorTypeId

Source

Since v1.0.0

utils

ValidationError (namespace)

Source

Since v1.0.0

Proto (interface)

Signature

export interface Proto {
  readonly [ValidationErrorTypeId]: ValidationErrorTypeId
}

Source

Since v1.0.0