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

ClientRequest overview

Added in v1.0.0


Table of contents


combinators

accept

Signature

export declare const accept: {
  (mediaType: string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, mediaType: string): ClientRequest
}

Added in v1.0.0

acceptJson

Signature

export declare const acceptJson: (self: ClientRequest) => ClientRequest

Added in v1.0.0

appendUrl

Signature

export declare const appendUrl: {
  (path: string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, path: string): ClientRequest
}

Added in v1.0.0

appendUrlParam

Signature

export declare const appendUrlParam: any

Added in v1.0.0

appendUrlParams

Signature

export declare const appendUrlParams: any

Added in v1.0.0

basicAuth

Signature

export declare const basicAuth: {
  (username: string, password: string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, username: string, password: string): ClientRequest
}

Added in v1.0.0

bearerToken

Signature

export declare const bearerToken: {
  (token: string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, token: string): ClientRequest
}

Added in v1.0.0

fileBody

Signature

export declare const fileBody: {
  (
    path: string,
    options?: FileSystem.StreamOptions & { readonly contentType?: string }
  ): (self: ClientRequest) => Effect.Effect<ClientRequest, PlatformError.PlatformError, FileSystem.FileSystem>
  (
    self: ClientRequest,
    path: string,
    options?: FileSystem.StreamOptions & { readonly contentType?: string }
  ): Effect.Effect<ClientRequest, PlatformError.PlatformError, FileSystem.FileSystem>
}

Added in v1.0.0

fileWebBody

Signature

export declare const fileWebBody: {
  (file: Body.Body.FileLike): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, file: Body.Body.FileLike): ClientRequest
}

Added in v1.0.0

formDataBody

Signature

export declare const formDataBody: {
  (body: FormData): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, body: FormData): ClientRequest
}

Added in v1.0.0

jsonBody

Signature

export declare const jsonBody: {
  (body: unknown): (self: ClientRequest) => Effect.Effect<ClientRequest, Body.BodyError>
  (self: ClientRequest, body: unknown): Effect.Effect<ClientRequest, Body.BodyError>
}

Added in v1.0.0

modify

Signature

export declare const modify: {
  (options: Options): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, options: Options): ClientRequest
}

Added in v1.0.0

prependUrl

Signature

export declare const prependUrl: {
  (path: string | URL): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, path: string): ClientRequest
}

Added in v1.0.0

schemaBody

Signature

export declare const schemaBody: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => {
  (body: A): (self: ClientRequest) => Effect.Effect<ClientRequest, Body.BodyError, R>
  (self: ClientRequest, body: A): Effect.Effect<ClientRequest, Body.BodyError, R>
}

Added in v1.0.0

setBody

Signature

export declare const setBody: {
  (body: Body.Body): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, body: Body.Body): ClientRequest
}

Added in v1.0.0

setHeader

Signature

export declare const setHeader: {
  (key: string, value: string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, key: string, value: string): ClientRequest
}

Added in v1.0.0

setHeaders

Signature

export declare const setHeaders: {
  (input: Headers.Input): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, input: Headers.Input): ClientRequest
}

Added in v1.0.0

setMethod

Signature

export declare const setMethod: {
  (method: Method): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, method: Method): ClientRequest
}

Added in v1.0.0

setUrl

Signature

export declare const setUrl: {
  (url: string | URL): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, url: string): ClientRequest
}

Added in v1.0.0

setUrlParam

Signature

export declare const setUrlParam: any

Added in v1.0.0

setUrlParams

Signature

export declare const setUrlParams: any

Added in v1.0.0

streamBody

Signature

export declare const streamBody: {
  (
    body: Stream.Stream<Uint8Array, unknown>,
    options?: { readonly contentType?: string | undefined; readonly contentLength?: number | undefined } | undefined
  ): (self: ClientRequest) => ClientRequest
  (
    self: ClientRequest,
    body: Stream.Stream<Uint8Array, unknown>,
    options?: { readonly contentType?: string | undefined; readonly contentLength?: number | undefined } | undefined
  ): ClientRequest
}

Added in v1.0.0

textBody

Signature

export declare const textBody: {
  (body: string, contentType?: string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, body: string, contentType?: string): ClientRequest
}

Added in v1.0.0

uint8ArrayBody

Signature

export declare const uint8ArrayBody: {
  (body: Uint8Array, contentType?: string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, body: Uint8Array, contentType?: string): ClientRequest
}

Added in v1.0.0

unsafeJsonBody

Signature

export declare const unsafeJsonBody: {
  (body: unknown): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, body: unknown): ClientRequest
}

Added in v1.0.0

updateUrl

Signature

export declare const updateUrl: {
  (f: (url: string) => string): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, f: (url: string) => string): ClientRequest
}

Added in v1.0.0

urlParamsBody

Signature

export declare const urlParamsBody: {
  (input: UrlParams.Input): (self: ClientRequest) => ClientRequest
  (self: ClientRequest, input: UrlParams.Input): ClientRequest
}

Added in v1.0.0

constructors

del

Signature

export declare const del: (url: string | URL, options?: Options.NoUrl) => ClientRequest

Added in v1.0.0

get

Signature

export declare const get: (url: string | URL, options?: Options.NoBody) => ClientRequest

Added in v1.0.0

Signature

export declare const head: (url: string | URL, options?: Options.NoBody) => ClientRequest

Added in v1.0.0

make

Signature

export declare const make: <M extends Method>(
  method: M
) => (
  url: string | URL,
  options?: (M extends "GET" | "HEAD" ? Options.NoBody : Options.NoUrl) | undefined
) => ClientRequest

Added in v1.0.0

options

Signature

export declare const options: (url: string | URL, options?: Options.NoUrl) => ClientRequest

Added in v1.0.0

patch

Signature

export declare const patch: (url: string | URL, options?: Options.NoUrl) => ClientRequest

Added in v1.0.0

post

Signature

export declare const post: (url: string | URL, options?: Options.NoUrl) => ClientRequest

Added in v1.0.0

put

Signature

export declare const put: (url: string | URL, options?: Options.NoUrl) => ClientRequest

Added in v1.0.0

models

ClientRequest (interface)

Signature

export interface ClientRequest
  extends Effect.Effect<ClientResponse, HttpClientError, Client.Default | Scope>,
    Inspectable {
  readonly [TypeId]: TypeId
  readonly method: Method
  readonly url: string
  readonly urlParams: UrlParams.UrlParams
  readonly headers: Headers.Headers
  readonly body: Body.Body
}

Added in v1.0.0

Options (interface)

Signature

export interface Options {
  readonly method?: Method | undefined
  readonly url?: string | undefined
  readonly urlParams?: UrlParams.Input | undefined
  readonly headers?: Headers.Input | undefined
  readonly body?: Body.Body | undefined
  readonly accept?: string | undefined
  readonly acceptJson?: boolean | undefined
}

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

utils

Options (namespace)

Added in v1.0.0

NoBody (interface)

Signature

export interface NoBody extends Omit<Options, "method" | "url" | "body"> {}

Added in v1.0.0

NoUrl (interface)

Signature

export interface NoUrl extends Omit<Options, "method" | "url"> {}

Added in v1.0.0