ClientError overview
Added in v1.0.0
Table of contents
error
HttpClientError (type alias)
Signature
export type HttpClientError = RequestError | ResponseError
Added in v1.0.0
RequestError
Signature
export declare const RequestError: (props: Omit<RequestError, HttpError.ProvidedFields>) => RequestError
Added in v1.0.0
RequestError (interface)
Signature
export interface RequestError extends HttpError.Proto {
readonly _tag: "RequestError"
readonly request: ClientRequest.ClientRequest
readonly reason: "Transport" | "Encode" | "InvalidUrl"
readonly error: unknown
}
Added in v1.0.0
ResponseError
Signature
export declare const ResponseError: (props: Omit<ResponseError, HttpError.ProvidedFields>) => ResponseError
Added in v1.0.0
ResponseError (interface)
Signature
export interface ResponseError extends HttpError.Proto {
readonly _tag: "ResponseError"
readonly request: ClientRequest.ClientRequest
readonly response: ClientResponse.ClientResponse
readonly reason: "StatusCode" | "Decode" | "EmptyBody"
readonly error: unknown
}
Added in v1.0.0
type id
TypeId
Signature
export declare const TypeId: typeof TypeId
Added in v1.0.0
TypeId (type alias)
Signature
export type TypeId = typeof TypeId
Added in v1.0.0
utils
HttpError (namespace)
Added in v1.0.0
Proto (interface)
Signature
export interface Proto extends Data.Case {
readonly [TypeId]: TypeId
readonly _tag: string
}
Added in v1.0.0
ProvidedFields (type alias)
Signature
export type ProvidedFields = TypeId | "_tag" | keyof Data.Case
Added in v1.0.0