ClientError overview
Models for errors being created on the client side.
Added in v1.0.0
Table of contents
constructors
makeClientSide
Signature
export declare const makeClientSide: (error: unknown, message?: string) => ClientErrorClientSide
Added in v1.0.0
makeClientSideRequestValidation
Signature
export declare const makeClientSideRequestValidation: (
location: string
) => (error: ParseResult.ParseError) => ClientErrorClientSide
Added in v1.0.0
makeClientSideResponseValidation
Signature
export declare const makeClientSideResponseValidation: (
location: string
) => (error: ParseResult.ParseError) => ClientErrorClientSide
Added in v1.0.0
makeServerSide
Signature
export declare const makeServerSide: <S extends number>(
error: unknown,
status: S,
message?: string
) => ClientErrorServerSide<S>
Added in v1.0.0
models
ClientError (type alias)
Signature
export type ClientError<S extends number = number> = ClientErrorClientSide | ClientErrorServerSide<S>
Added in v1.0.0
ClientErrorClientSide (interface)
Signature
export interface ClientErrorClientSide extends Cause.YieldableError {
readonly [ClientSideErrorTypeId]: {}
readonly _tag: "ClientError"
readonly message: string
readonly error: unknown
readonly side: "client"
}
Added in v1.0.0
ClientErrorServerSide (interface)
Signature
export interface ClientErrorServerSide<S extends number = number> extends Cause.YieldableError {
readonly [ServerSideErrorTypeId]: {}
readonly _tag: "ClientError"
readonly message: string
readonly error: unknown
readonly status: S
readonly side: "server"
}
Added in v1.0.0
refinements
isClientSideError
Signature
export declare const isClientSideError: (u: unknown) => u is ClientErrorClientSide
Added in v1.0.0
isServerSideError
Signature
export declare const isServerSideError: (u: unknown) => u is ClientErrorServerSide<number>
Added in v1.0.0
type id
ClientSideErrorTypeId
Signature
export declare const ClientSideErrorTypeId: typeof ClientSideErrorTypeId
Added in v1.0.0
ClientSideErrorTypeId (type alias)
Signature
export type ClientSideErrorTypeId = typeof ClientSideErrorTypeId
Added in v1.0.0
ServerSideErrorTypeId
Signature
export declare const ServerSideErrorTypeId: typeof ServerSideErrorTypeId
Added in v1.0.0
ServerSideErrorTypeId (type alias)
Signature
export type ServerSideErrorTypeId = typeof ServerSideErrorTypeId
Added in v1.0.0