HttpClientRequest
Combinators
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;Signature
declare const appendUrl: {
(path: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, path: string): HttpClientRequest;
};appendUrlParam
Added in v1.0.0
Source
Signature
declare const appendUrlParam: {
(key: string, value: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, key: string, value: string): HttpClientRequest;
};appendUrlParams
Added in v1.0.0
Source
Signature
declare const appendUrlParams: {
(input: Input): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, input: Input): HttpClientRequest;
};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;
};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;
};bodyFormDataRecord
Added in v1.0.0
Source
Signature
declare const bodyFormDataRecord: {
(entries: Body.FormDataInput): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, entries: Body.FormDataInput): HttpClientRequest;
};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;
};Signature
declare const bodyText: {
(body: string, contentType?: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: string, contentType?: string): HttpClientRequest;
};bodyUint8Array
Added in v1.0.0
Source
Signature
declare const bodyUint8Array: {
(body: Uint8Array, contentType?: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: Uint8Array, contentType?: string): HttpClientRequest;
};bodyUnsafeJson
Added in v1.0.0
Source
Signature
declare const bodyUnsafeJson: {
(body: unknown): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: unknown): HttpClientRequest;
};bodyUrlParams
Added in v1.0.0
Source
Signature
declare const bodyUrlParams: {
(input: Input): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, input: Input): HttpClientRequest;
};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;schemaBodyJson
Added in v1.0.0
Source
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>;
};Signature
declare const setBody: {
(body: HttpBody): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, body: HttpBody): HttpClientRequest;
};Signature
declare const setHash: {
(hash: string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, hash: string): HttpClientRequest;
};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;
};Signature
declare const setMethod: {
(method: HttpMethod): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, method: HttpMethod): HttpClientRequest;
};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;
};Signature
declare const toUrl: (self: HttpClientRequest) => Option.Option<URL>;Signature
declare const updateUrl: {
(f: (url: string) => string): (self: HttpClientRequest) => HttpClientRequest;
(self: HttpClientRequest, f: (url: string) => string): HttpClientRequest;
};Constructors
Signature
declare const del: (url: string | URL, options?: Options.NoUrl) => HttpClientRequest;Signature
declare const get: (url: string | URL, options?: Options.NoBody) => HttpClientRequest;Signature
declare const head: (url: string | URL, options?: Options.NoBody) => HttpClientRequest;Signature
declare const make: <M extends HttpMethod>(
method: M,
) => (
url: string | URL,
options?: M extends "GET" | "HEAD" ? Options.NoBody : Options.NoUrl,
) => HttpClientRequest;Signature
declare const options: (url: string | URL, options?: Options.NoUrl) => HttpClientRequest;Signature
declare const patch: (url: string | URL, options?: Options.NoUrl) => HttpClientRequest;Signature
declare const post: (url: string | URL, options?: Options.NoUrl) => HttpClientRequest;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;
}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;
}