Type alias ErrorResponse<Meta, Obstructions>

ErrorResponse<Meta, Obstructions>: {
    t: "error";
    error: {
        title: string;
        code?: string | null;
        status: number;
        detail: string;
        obstructions?: Obstructions[];
    };
    meta?: Meta;
}

A typical error response

Type Parameters

  • Meta extends unknown = unknown

  • Obstructions extends ObstructionInterface = ObstructionInterface

Type declaration

  • t: "error"
  • error: {
        title: string;
        code?: string | null;
        status: number;
        detail: string;
        obstructions?: Obstructions[];
    }
    • title: string
    • Optional code?: string | null
    • status: number
    • detail: string
    • Optional obstructions?: Obstructions[]
  • Optional meta?: Meta

Generated using TypeDoc