Interface RequestOptions<Data, Params>

Options for customizing REST requests

interface RequestOptions<
    Data extends JsonLike = EmptyObject,
    Params extends JsonLike = EmptyObject,
> {
    data?: Data;
    params?: Params;
    signal?: AbortSignal;
    timeout?: number;
}

Type Parameters

Data extends JsonLike = EmptyObject
Params extends JsonLike = EmptyObject

Index

Properties

data? params? signal? timeout?

Properties

`Optional`data

data?: Data

The JSON data to attach in request body

`Optional`params

params?: Params

The query params to append to the endpoint

`Optional`signal

signal?: AbortSignal

The abort signal for this request

`Optional`timeout

timeout?: number

The timeout for this request