Class FluentRequest

Fluent (chained) request builder. Each method returns this for chaining; call .send() or a parser method to execute.

Example

const data = await client
  .GET("/users")
  .header("x-api-version", "2")
  .param("page", 1)
  .timeout(5000)
  .retry(2)
  .json<User[]>();

Index

Constructors

constructor

new FluentRequest(
    client: Kinetex,
    method: HTTPMethod,
    url: string,
): FluentRequest
Parameters
- client: Kinetex
  The parent Kinetex instance.
- method: HTTPMethod
  HTTP method for this request.
- url: string
  Request URL (relative to baseURL or absolute).
Returns FluentRequest
- Defined in src/client.ts:2969

Methods

header(name: string, value: string): this
Set or override a single header.
Parameters
- name: string
- value: string
Returns this
- Defined in src/client.ts:2980

headers

headers(headers: HeadersInit): this
Merge a headers map.
Parameters
- headers: HeadersInit
Returns this
- Defined in src/client.ts:2989

param

param(key: string, value: QueryValue): this
Set a single query parameter.
Parameters
- key: string
- value: QueryValue
Returns this
- Defined in src/client.ts:3000

params

params(params: QueryParams): this
Merge a query params map.
Parameters
- params: QueryParams
Returns this
- Defined in src/client.ts:3006

withBody

withBody(body: BodyInit): this
Set the request body.
Parameters
- body: BodyInit
Returns this
- Defined in src/client.ts:3014

withJSON

withJSON(data: unknown): this
Set a JSON body (serializes and sets Content-Type).
Parameters
- data: unknown
Returns this
- Defined in src/client.ts:3020

withForm

withForm(data: FormData): this
Set a FormData body.
Parameters
- data: FormData
Returns this
- Defined in src/client.ts:3030

bearer

bearer(token: string | (() => string | Promise<string>)): this
Set Bearer token authentication.
Parameters
- token: string | (() => string | Promise<string>)
Returns this
- Defined in src/client.ts:3038

basic

basic(username: string, password: string): this
Set Basic authentication.
Parameters
- username: string
- password: string
Returns this
- Defined in src/client.ts:3044

apiKey

apiKey(header: string, key: string): this
Set API key authentication.
Parameters
- header: string
- key: string
Returns this
- Defined in src/client.ts:3050

digest

digest(username: string, password: string): this
Set Digest Access Authentication (RFC 7616).
Parameters
- username: string
- password: string
Returns this
- Defined in src/client.ts:3056

noAuth

noAuth(): this
Disable auth for this request.

Returns this
- Defined in src/client.ts:3062

retry

retry(maxRetries: number, options?: Partial<RetryConfig>): this
Set max retry count.
Parameters
- maxRetries: number
- Optionaloptions: Partial<RetryConfig>
Returns this
- Defined in src/client.ts:3070

noRetry

noRetry(): this
Disable retry for this request.

Returns this
- Defined in src/client.ts:3076

timeout

timeout(ms: number): this
Set request timeout in ms.
Parameters
- ms: number
Returns this
- Defined in src/client.ts:3084

proxy

proxy(config: ProxyConfig): this
Set proxy for this request.
Parameters
- config: ProxyConfig
Returns this
- Defined in src/client.ts:3092

cache

cache(config: false | CacheRequestConfig): this
Configure caching for this request.
Parameters
- config: false | CacheRequestConfig
Returns this
- Defined in src/client.ts:3100

noCache

noCache(): this
Force a fresh fetch, bypassing any cached response.

Returns this
- Defined in src/client.ts:3106

onUploadProgress

onUploadProgress(cb: ProgressCallback): this
Register an upload progress callback.
Parameters
- cb: ProgressCallback
Returns this
- Defined in src/client.ts:3114

onDownloadProgress

onDownloadProgress(cb: ProgressCallback): this
Register a download progress callback.
Parameters
- cb: ProgressCallback
Returns this
- Defined in src/client.ts:3120

signal

signal(signal: AbortSignal): this
Attach an AbortSignal for cancellation.
Parameters
- signal: AbortSignal
Returns this
- Defined in src/client.ts:3128

maxSize

maxSize(bytes: number): this
Set maximum response body size in bytes.
Parameters
- bytes: number
Returns this
- Defined in src/client.ts:3136

http2

http2(): this
Request HTTP/2.

Returns this
- Defined in src/client.ts:3144

http1

http1(): this
Request HTTP/1.1.

Returns this
- Defined in src/client.ts:3150

noThrow

noThrow(): this
Do not throw on 4xx/5xx status codes.

Returns this
- Defined in src/client.ts:3158

send

send<T = unknown>(): Promise<KinetexResponse<T>>
Execute and return the full KinetexResponse.
Type Parameters
- T = unknown
Returns Promise<KinetexResponse<T>>
- Defined in src/client.ts:3182

data

data<T = unknown>(): Promise<T>
Execute and return the parsed data. Alias for .send().then(r => r.data).
Type Parameters
- T = unknown
Returns Promise<T>
- Defined in src/client.ts:3187

json

json<T = unknown>(): Promise<T>
Execute, parse as JSON, and return the typed data.
Type Parameters
- T = unknown
Returns Promise<T>
- Defined in src/client.ts:3193

text

text(): Promise<string>
Execute, parse as text, and return the string.

Returns Promise<string>
- Defined in src/client.ts:3201

bytes

bytes(): Promise<Uint8Array<ArrayBufferLike>>
Execute, return raw bytes.

Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in src/client.ts:3209

blob

blob(): Promise<Blob>
Execute, return a Blob.

Returns Promise<Blob>
- Defined in src/client.ts:3217

subscribe<T = unknown>(
onSuccess: (res: KinetexResponse<T>) => void,
onError?: (err: KinetexError) => void,
): void
Execute with callback-style handlers.
Type Parameters
- T = unknown
Parameters
- onSuccess: (res: KinetexResponse<T>) => void
- OptionalonError: (err: KinetexError) => void
Returns void
- Defined in src/client.ts:3227

Class FluentRequest

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FluentRequest

Methods

header

Parameters

Returns this

headers

Parameters

Returns this

param

Parameters

Returns this

params

Parameters

Returns this

withBody

Parameters

Returns this

withJSON

Parameters

Returns this

withForm

Parameters

Returns this

bearer

Parameters

Returns this

basic

Parameters

Returns this

apiKey

Parameters

Returns this

digest

Parameters

Returns this

noAuth

Returns this

retry

Parameters

Returns this

noRetry

Returns this

timeout

Parameters

Returns this

proxy

Parameters

Returns this

cache

Parameters

Returns this

noCache

Returns this

onUploadProgress

Parameters

Returns this

onDownloadProgress

Parameters

Returns this

signal

Parameters

Returns this

maxSize

Parameters

Returns this

http2

Returns this

http1

Returns this

noThrow

Returns this

tags