Interface DecodingFailure

Represents a decoding with a decoding error.

interface DecodingFailure {
    errors: DecodingErrors;
    failed: true;
    reason: string;
    success: false;
    concat(errors): DecodingErrors;
    foreach(fun): void;
    map<T>(fun): T[];
}

Hierarchy (view full)

DecodingFailureUtils
- DecodingFailure

Index

Properties

errors failed reason success

Methods

concat foreach map

Properties

errors

errors: DecodingErrors

failed

failed: true

reason

reason: string

success

success: false

Methods

concat

concat(errors): DecodingErrors
Combine this decoding failure with another decoding failure.
Parameters
- errors: DecodingFailure
  Decoding failure to combine with this.
Returns DecodingErrors
Inherited from DecodingFailureUtils.concat

foreach

foreach(fun): void
Apply an operation on every decoding error and an array of paths where that error occurred.
Parameters
- fun: ((message, paths) => void)
  operation
  - - (message, paths): void
    - Parameters
      message: string
      paths: Path[]
      Returns void
Returns void
Inherited from DecodingFailureUtils.foreach

map

map<T>(fun): T[]
Transform decoding errors by applying a transformer on every error and an array of paths where that error occurred.
Type Parameters
- T
  type of transformation result
Parameters
- fun: ((message, paths) => T)
  transformer function
  - - (message, paths): T
    - Parameters
      message: string
      paths: Path[]
      Returns T
Returns T[]
Inherited from DecodingFailureUtils.map

Generated using TypeDoc