The io-ts-better-union-error-reporter from klesun

io-ts-better-union-error-reporter's Introduction

A pretty-printer for io-ts errors that filters out irrelevant unions by the identifying tag literal in input data - it chooses the union option with the most fields covered.

Installation:

npm i io-ts-better-union-error-reporter

Usage example:

import PrettyPrintIoTsErrors from "io-ts-better-union-error-reporter/dist/PrettyPrintIoTsErrors";
import * as t from "io-ts";

const someType: t.Decoder<unknown, unknown> = t.type({...});
const validated = someType.decode(someData);
if (validated._tag === 'Left') { // decode error
    const message = PrettyPrintIoTsErrors(validated.left);
    console.log('io-ts validation failed!', message);
}

Example output:

array [
  # example with {"kind": "primitive"} supplied as input data
  at [7] object {
    name: string is mandatory
    type: "boolean"|"address"|"integer"|"string"|object|"uint256"|"int256"|string is mandatory
  # example with {} supplied as input data
  at [11] must satisfy either of
    | object {
      kind: "function" is mandatory
      inputs: CompilerDataType[] is mandatory
      output: CompilerDataType is mandatory
      id: string is mandatory
      name: string is mandatory
    | object {
      name: string is mandatory
      kind: "primitive" is mandatory
      type: "boolean"|"address"|"integer"|"string"|object|"uint256"|"int256"|string is mandatory
    | object {
      kind: "struct" is mandatory
      fields: NsFunctionField[] is mandatory
      name: string is mandatory
    | object {
      name: string is mandatory
      kind: "table" is mandatory
      fields: Field[] is mandatory
    | must satisfy every of
      & object {
        metadataId: string is mandatory
      & expected one of
         | { name: string, kind: "primitive", type: (("boolean" | "address" | "in...
         | { name: string, kind: "table", fields: Array<{ name: string, type: ({ ...
         | { kind: "struct", fields: Array<{ name: string, type: ("boolean" | "ad...

Recommend Projects