Skip to content
Effect Days 2026 Get your ticket

HttpClientRequest

44 exports Added in v1.0.0 Source

Combinators

accept

Added in v1.0.0 Source

Signature

declare const accept: {
(mediaType: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, mediaType: string): HttpClientRequest;
}

acceptJson

Added in v1.0.0 Source

Signature

declare const acceptJson: (self: HttpClientRequest) => HttpClientRequest

appendUrl

Added in v1.0.0 Source

Signature

declare const appendUrl: {
(path: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, path: string): HttpClientRequest;
}

Signature

declare const appendUrlParam: {
(key: string, value: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, key: string, value: string): HttpClientRequest;
}

Signature

declare const appendUrlParams: {
(input: Input): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, input: Input): HttpClientRequest;
}

basicAuth

Added in v1.0.0 Source

Signature

declare const basicAuth: {
(username: string | Redacted<string>, password: string | Redacted<string>): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, username: string | Redacted<string>, password: string | Redacted<string>): HttpClientRequest;
}

bearerToken

Added in v1.0.0 Source

Signature

declare const bearerToken: {
(token: string | Redacted<string>): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, token: string | Redacted<string>): HttpClientRequest;
}

bodyFile

Added in v1.0.0 Source

Signature

declare const bodyFile: {
(path: string, options?: StreamOptions & {
readonly contentType?: string;
}): (self: HttpClientRequest) => Effect<HttpClientRequest, PlatformError, FileSystem>;
(self: HttpClientRequest, path: string, options?: StreamOptions & {
readonly contentType?: string;
}): Effect<HttpClientRequest, PlatformError, FileSystem>;
}

bodyFileWeb

Added in v1.0.0 Source

Signature

declare const bodyFileWeb: {
(file: FileLike): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, file: FileLike): HttpClientRequest;
}

bodyFormData

Added in v1.0.0 Source

Signature

declare const bodyFormData: {
(body: FormData): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: FormData): HttpClientRequest;
}

Signature

declare const bodyFormDataRecord: {
(entries: Body.FormDataInput): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, entries: Body.FormDataInput): HttpClientRequest;
}

bodyJson

Added in v1.0.0 Source

Signature

declare const bodyJson: {
(body: unknown): (self: HttpClientRequest) => Effect<HttpClientRequest, HttpBodyError>;
(self: HttpClientRequest, body: unknown): Effect<HttpClientRequest, HttpBodyError>;
}

bodyStream

Added in v1.0.0 Source

Signature

declare const bodyStream: {
(body: Stream<Uint8Array<ArrayBufferLike>, unknown>, options?: {
readonly contentLength?: number;
readonly contentType?: string;
}): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: Stream<Uint8Array<ArrayBufferLike>, unknown>, options?: {
readonly contentLength?: number;
readonly contentType?: string;
}): HttpClientRequest;
}

bodyText

Added in v1.0.0 Source

Signature

declare const bodyText: {
(body: string, contentType?: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: string, contentType?: string): HttpClientRequest;
}

Signature

declare const bodyUint8Array: {
(body: Uint8Array, contentType?: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: Uint8Array, contentType?: string): HttpClientRequest;
}

Signature

declare const bodyUnsafeJson: {
(body: unknown): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: unknown): HttpClientRequest;
}

Signature

declare const bodyUrlParams: {
(input: Input): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, input: Input): HttpClientRequest;
}

modify

Added in v1.0.0 Source

Signature

declare const modify: {
(options: Options): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, options: Options): HttpClientRequest;
}

prependUrl

Added in v1.0.0 Source

Signature

declare const prependUrl: {
(path: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, path: string): HttpClientRequest;
}

removeHash

Added in v1.0.0 Source

Signature

declare const removeHash: (self: HttpClientRequest) => HttpClientRequest

Signature

declare const schemaBodyJson: <A, I, R>(schema: Schema.Schema<A, I, R>, options?: ParseOptions) => {
(body: A): (self: HttpClientRequest) => Effect<HttpClientRequest, HttpBodyError, R>;
(self: HttpClientRequest, body: A): Effect<HttpClientRequest, HttpBodyError, R>;
}

setBody

Added in v1.0.0 Source

Signature

declare const setBody: {
(body: HttpBody): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: HttpBody): HttpClientRequest;
}

setHash

Added in v1.0.0 Source

Signature

declare const setHash: {
(hash: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, hash: string): HttpClientRequest;
}

setHeader

Added in v1.0.0 Source

Signature

declare const setHeader: {
(key: string, value: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, key: string, value: string): HttpClientRequest;
}

setHeaders

Added in v1.0.0 Source

Signature

declare const setHeaders: {
(input: Input): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, input: Input): HttpClientRequest;
}

setMethod

Added in v1.0.0 Source

Signature

declare const setMethod: {
(method: HttpMethod): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, method: HttpMethod): HttpClientRequest;
}

setUrl

Added in v1.0.0 Source

Signature

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

setUrlParam

Added in v1.0.0 Source

Signature

declare const setUrlParam: {
(key: string, value: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, key: string, value: string): HttpClientRequest;
}

setUrlParams

Added in v1.0.0 Source

Signature

declare const setUrlParams: {
(input: Input): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, input: Input): HttpClientRequest;
}

toUrl

Added in v1.0.0 Source

Signature

declare const toUrl: (self: HttpClientRequest) => Option.Option<URL>

updateUrl

Added in v1.0.0 Source

Signature

declare const updateUrl: {
(f: (url: string) => string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, f: (url: string) => string): HttpClientRequest;
}

Constructors

del

Added in v1.0.0 Source

Signature

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

get

Added in v1.0.0 Source

Signature

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

make

Added in v1.0.0 Source

Signature

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

options

Added in v1.0.0 Source

Signature

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

patch

Added in v1.0.0 Source

Signature

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

post

Added in v1.0.0 Source

Signature

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

put

Added in v1.0.0 Source

Signature

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

Models

HttpClientRequest interface

Added in v1.0.0 Source

Signature

interface HttpClientRequest extends Inspectable, Pipeable {
readonly [TypeId]: typeof TypeId;
readonly body: HttpBody;
readonly hash: Option<string>;
readonly headers: Headers;
readonly method: HttpMethod;
readonly url: string;
readonly urlParams: UrlParams;
}

Options interface

Added in v1.0.0 Source

Signature

interface Options {
readonly accept?: string;
readonly acceptJson?: boolean;
readonly body?: HttpBody;
readonly hash?: string;
readonly headers?: Input;
readonly method?: HttpMethod;
readonly url?: string | URL;
readonly urlParams?: Input;
}

Other

Options

Added in v1.0.0 Source

Type Ids

TypeId

Added in v1.0.0 Source

Signature

declare const TypeId: unique symbol

TypeId type

Added in v1.0.0 Source

Signature

type TypeId = typeof TypeId