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

ClientResponse overview

Added in v1.0.0


Table of contents


constructors

fromWeb

Signature

export declare const fromWeb: (request: ClientRequest.ClientRequest, source: Response) => ClientResponse

Added in v1.0.0

models

ClientResponse (interface)

Signature

export interface ClientResponse extends IncomingMessage.IncomingMessage<Error.ResponseError> {
  readonly [TypeId]: TypeId
  readonly status: number
  readonly formData: Effect.Effect<never, Error.ResponseError, FormData>
}

Added in v1.0.0

schema

schemaBodyJson

Signature

export declare const schemaBodyJson: <I, A>(
  schema: Schema.Schema<I, A>
) => <E>(self: IncomingMessage.IncomingMessage<E>) => Effect.Effect<never, ParseResult.ParseError | E, A>

Added in v1.0.0

schemaBodyUrlParams

Signature

export declare const schemaBodyUrlParams: <I extends Readonly<Record<string, string>>, A>(
  schema: Schema.Schema<I, A>
) => <E>(self: IncomingMessage.IncomingMessage<E>) => Effect.Effect<never, ParseResult.ParseError | E, A>

Added in v1.0.0

schemaHeaders

Signature

export declare const schemaHeaders: <I extends Readonly<Record<string, string>>, A>(
  schema: Schema.Schema<I, A>
) => <E>(self: IncomingMessage.IncomingMessage<E>) => Effect.Effect<never, ParseResult.ParseError, A>

Added in v1.0.0

schemaJson

Signature

export declare const schemaJson: <
  I extends {
    readonly status?: number | undefined
    readonly headers?: Readonly<Record<string, string>> | undefined
    readonly body?: unknown
  },
  A
>(
  schema: Schema.Schema<I, A>
) => (self: ClientResponse) => Effect.Effect<never, ParseResult.ParseError | Error.ResponseError, A>

Added in v1.0.0

schemaNoBody

Signature

export declare const schemaNoBody: <
  I extends { readonly status?: number | undefined; readonly headers?: Readonly<Record<string, string>> | undefined },
  A
>(
  schema: Schema.Schema<I, A>
) => (self: ClientResponse) => Effect.Effect<never, ParseResult.ParseError, A>

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