Skip to main content Link Search Menu Expand Document (external link)

HttpApiError overview

Added in v1.0.0


Table of contents


empty errors

BadRequest (class)

Signature

export declare class BadRequest

Added in v1.0.0

Conflict (class)

Signature

export declare class Conflict

Added in v1.0.0

Forbidden (class)

Signature

export declare class Forbidden

Added in v1.0.0

Gone (class)

Signature

export declare class Gone

Added in v1.0.0

InternalServerError (class)

Signature

export declare class InternalServerError

Added in v1.0.0

MethodNotAllowed (class)

Signature

export declare class MethodNotAllowed

Added in v1.0.0

NotAcceptable (class)

Signature

export declare class NotAcceptable

Added in v1.0.0

NotFound (class)

Signature

export declare class NotFound

Added in v1.0.0

NotImplemented (class)

Signature

export declare class NotImplemented

Added in v1.0.0

RequestTimeout (class)

Signature

export declare class RequestTimeout

Added in v1.0.0

ServiceUnavailable (class)

Signature

export declare class ServiceUnavailable

Added in v1.0.0

Unauthorized (class)

Signature

export declare class Unauthorized

Added in v1.0.0

errors

HttpApiDecodeError (class)

Signature

export declare class HttpApiDecodeError

Added in v1.0.0

fromParseError (static method)

Signature

static fromParseError(error: ParseResult.ParseError): Effect.Effect<HttpApiDecodeError>

Added in v1.0.0

refailParseError (static method)

Signature

static refailParseError(error: ParseResult.ParseError): Effect.Effect<never, HttpApiDecodeError>

Added in v1.0.0

schemas

Issue

Signature

export declare const Issue: Issue

Added in v1.0.0

Issue (interface)

Signature

export interface Issue
  extends Schema.Struct<{
    _tag: Schema.Literal<
      ["Pointer", "Unexpected", "Missing", "Composite", "Refinement", "Transformation", "Type", "Forbidden"]
    >
    path: PropertyKeysNoSymbol
    message: typeof Schema.String
  }> {}

Added in v1.0.0

PropertyKeysNoSymbol

Signature

export declare const PropertyKeysNoSymbol: PropertyKeysNoSymbol

Added in v1.0.0

PropertyKeysNoSymbol (interface)

Signature

export interface PropertyKeysNoSymbol
  extends Schema.transform<
    Schema.Array$<Schema.Union<[typeof Schema.String, typeof Schema.Number]>>,
    Schema.Array$<Schema.Union<[typeof Schema.SymbolFromSelf, typeof Schema.String, typeof Schema.Number]>>
  > {}

Added in v1.0.0

type ids

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