Clov Packages
    Preparing search index...

    Interface DefineExceptionCatalogOptions<TDefs>

    Configuration for defineExceptionCatalog.

    interface DefineExceptionCatalogOptions<TDefs extends EntryMap> {
        defaultLocale: LocalesOf<TDefs>;
        definitions: TDefs & ExactEntries<
            TDefs,
            {
                status?: | "CONTINUE"
                | "SWITCHING_PROTOCOLS"
                | "PROCESSING"
                | "EARLY_HINTS"
                | "OK"
                | "CREATED"
                | "ACCEPTED"
                | "NON_AUTHORITATIVE_INFORMATION"
                | "NO_CONTENT"
                | "RESET_CONTENT"
                | "PARTIAL_CONTENT"
                | "MULTI_STATUS"
                | "ALREADY_REPORTED"
                | "IM_USED"
                | "MULTIPLE_CHOICES"
                | "MOVED_PERMANENTLY"
                | "FOUND"
                | "SEE_OTHER"
                | "NOT_MODIFIED"
                | "USE_PROXY"
                | "SWITCH_PROXY"
                | "TEMPORARY_REDIRECT"
                | "PERMANENT_REDIRECT"
                | "BAD_REQUEST"
                | "UNAUTHORIZED"
                | "PAYMENT_REQUIRED"
                | "FORBIDDEN"
                | "NOT_FOUND"
                | "METHOD_NOT_ALLOWED"
                | "NOT_ACCEPTABLE"
                | "PROXY_AUTHENTICATION_REQUIRED"
                | "REQUEST_TIMEOUT"
                | "CONFLICT"
                | "GONE"
                | "LENGTH_REQUIRED"
                | "PRECONDITION_FAILED"
                | "PAYLOAD_TOO_LARGE"
                | "URI_TOO_LONG"
                | "UNSUPPORTED_MEDIA_TYPE"
                | "RANGE_NOT_SATISFIABLE"
                | "EXPECTATION_FAILED"
                | "IM_A_TEAPOT"
                | "MISDIRECTED_REQUEST"
                | "UNPROCESSABLE_ENTITY"
                | "LOCKED"
                | "FAILED_DEPENDENCY"
                | "TOO_EARLY"
                | "UPGRADE_REQUIRED"
                | "PRECONDITION_REQUIRED"
                | "TOO_MANY_REQUESTS"
                | "REQUEST_HEADER_FIELDS_TOO_LARGE"
                | "UNAVAILABLE_FOR_LEGAL_REASONS"
                | "INTERNAL_SERVER_ERROR"
                | "NOT_IMPLEMENTED"
                | "BAD_GATEWAY"
                | "SERVICE_UNAVAILABLE"
                | "GATEWAY_TIMEOUT"
                | "HTTP_VERSION_NOT_SUPPORTED"
                | "VARIANT_ALSO_NEGOTIATES"
                | "INSUFFICIENT_STORAGE"
                | "LOOP_DETECTED"
                | "NOT_EXTENDED"
                | "NETWORK_AUTHENTICATION_REQUIRED"
                | HttpStatusCode;
                translations: Record<LocalesOf<TDefs>, string>;
            },
        >;
    }

    Type Parameters

    • TDefs extends EntryMap

      Shape of the exception definitions map.

    Index
    defaultLocale definitions
    defaultLocale: LocalesOf<TDefs>

    Locale used to build the default message when no locale is specified.

    definitions: TDefs & ExactEntries<
        TDefs,
        {
            status?: | "CONTINUE"
            | "SWITCHING_PROTOCOLS"
            | "PROCESSING"
            | "EARLY_HINTS"
            | "OK"
            | "CREATED"
            | "ACCEPTED"
            | "NON_AUTHORITATIVE_INFORMATION"
            | "NO_CONTENT"
            | "RESET_CONTENT"
            | "PARTIAL_CONTENT"
            | "MULTI_STATUS"
            | "ALREADY_REPORTED"
            | "IM_USED"
            | "MULTIPLE_CHOICES"
            | "MOVED_PERMANENTLY"
            | "FOUND"
            | "SEE_OTHER"
            | "NOT_MODIFIED"
            | "USE_PROXY"
            | "SWITCH_PROXY"
            | "TEMPORARY_REDIRECT"
            | "PERMANENT_REDIRECT"
            | "BAD_REQUEST"
            | "UNAUTHORIZED"
            | "PAYMENT_REQUIRED"
            | "FORBIDDEN"
            | "NOT_FOUND"
            | "METHOD_NOT_ALLOWED"
            | "NOT_ACCEPTABLE"
            | "PROXY_AUTHENTICATION_REQUIRED"
            | "REQUEST_TIMEOUT"
            | "CONFLICT"
            | "GONE"
            | "LENGTH_REQUIRED"
            | "PRECONDITION_FAILED"
            | "PAYLOAD_TOO_LARGE"
            | "URI_TOO_LONG"
            | "UNSUPPORTED_MEDIA_TYPE"
            | "RANGE_NOT_SATISFIABLE"
            | "EXPECTATION_FAILED"
            | "IM_A_TEAPOT"
            | "MISDIRECTED_REQUEST"
            | "UNPROCESSABLE_ENTITY"
            | "LOCKED"
            | "FAILED_DEPENDENCY"
            | "TOO_EARLY"
            | "UPGRADE_REQUIRED"
            | "PRECONDITION_REQUIRED"
            | "TOO_MANY_REQUESTS"
            | "REQUEST_HEADER_FIELDS_TOO_LARGE"
            | "UNAVAILABLE_FOR_LEGAL_REASONS"
            | "INTERNAL_SERVER_ERROR"
            | "NOT_IMPLEMENTED"
            | "BAD_GATEWAY"
            | "SERVICE_UNAVAILABLE"
            | "GATEWAY_TIMEOUT"
            | "HTTP_VERSION_NOT_SUPPORTED"
            | "VARIANT_ALSO_NEGOTIATES"
            | "INSUFFICIENT_STORAGE"
            | "LOOP_DETECTED"
            | "NOT_EXTENDED"
            | "NETWORK_AUTHENTICATION_REQUIRED"
            | HttpStatusCode;
            translations: Record<LocalesOf<TDefs>, string>;
        },
    >

    Map of exception definitions keyed by error name. Every entry covers the same locales and carries nothing beyond an optional status and its translations.

    Settings
    Member Visibility

    On This Page
    Properties