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

HttpClientRequest.ts overview

Since v1.0.0

Exports Grouped by Category

combinators

accept

Signature

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

Source

Since v1.0.0

acceptJson

Signature

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

Source

Since v1.0.0

appendUrl

Signature

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

Source

Since v1.0.0

appendUrlParam

Signature

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

Source

Since v1.0.0

appendUrlParams

Signature

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

Source

Since v1.0.0

basicAuth

Signature

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

Source

Since v1.0.0

bearerToken

Signature

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

Source

Since v1.0.0

bodyFile

Signature

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

Source

Since v1.0.0

bodyFileWeb

Signature

declare const bodyFileWeb: {
  (file: Body.HttpBody.FileLike): (self: HttpClientRequest) => HttpClientRequest
  (self: HttpClientRequest, file: Body.HttpBody.FileLike): HttpClientRequest
}

Source

Since v1.0.0

bodyFormData

Signature

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

Source

Since v1.0.0

bodyFormDataRecord

Signature

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

Source

Since v1.0.0

bodyJson

Signature

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

Source

Since v1.0.0

bodyStream

Signature

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

Source

Since v1.0.0

bodyText

Signature

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

Source

Since v1.0.0

bodyUint8Array

Signature

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

Source

Since v1.0.0

bodyUnsafeJson

Signature

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

Source

Since v1.0.0

bodyUrlParams

Signature

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

Source

Since v1.0.0

modify

Signature

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

Source

Since v1.0.0

prependUrl

Signature

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

Source

Since v1.0.0

removeHash

Signature

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

Source

Since v1.0.0

schemaBodyJson

Signature

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

Source

Since v1.0.0

setBody

Signature

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

Source

Since v1.0.0

setHash

Signature

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

Source

Since v1.0.0

setHeader

Signature

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

Source

Since v1.0.0

setHeaders

Signature

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

Source

Since v1.0.0

setMethod

Signature

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

Source

Since v1.0.0

setUrl

Signature

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

Source

Since v1.0.0

setUrlParam

Signature

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

Source

Since v1.0.0

setUrlParams

Signature

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

Source

Since v1.0.0

toUrl

Signature

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

Source

Since v1.0.0

updateUrl

Signature

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

Source

Since v1.0.0

constructors

del

Signature

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

Source

Since v1.0.0

get

Signature

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

Source

Since v1.0.0

Signature

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

Source

Since v1.0.0

make

Signature

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

Source

Since v1.0.0

options

Signature

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

Source

Since v1.0.0

patch

Signature

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

Source

Since v1.0.0

post

Signature

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

Source

Since v1.0.0

put

Signature

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

Source

Since v1.0.0

models

HttpClientRequest (interface)

Signature

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

Source

Since v1.0.0

Options (interface)

Signature

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

Source

Since v1.0.0

type ids

TypeId

Signature

declare const TypeId: unique symbol

Source

Since v1.0.0

TypeId (type alias)

Signature

type TypeId = typeof TypeId

Source

Since v1.0.0

utils

Options (namespace)

Source

Since v1.0.0

NoBody (interface)

Signature

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

Source

Since v1.0.0

NoUrl (interface)

Signature

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

Source

Since v1.0.0