Interface IProps<T>

Properties for the exception.

interface IProps<T> {
    description?: string;
    example?: T;
    examples?: Record<string, IExample<T>>;
    status: number | "2XX" | "3XX" | "4XX" | "5XX";
}

Type Parameters

  • T

Properties

description? example? examples? status

Properties

Optionaldescription

description?: string

Description about the exception.

Optionalexample

example?: T

Example value.

Optionalexamples

examples?: Record<string, IExample<T>>

Collection of examples for the exception.

status

status: number | "2XX" | "3XX" | "4XX" | "5XX"

Status number or pattern like "2XX", "3XX", "4XX", "5XX".

Settings

Member Visibility

On This Page

Properties