Documentation / @imvu/rest / RequestOptions

Interface: RequestOptions

Defined in: packages/rest/src/rest.ts:19

Options for a single request.

Properties

baseURL?

baseURL?: string;

Defined in: packages/rest/src/rest.ts:29

Base URL for a relative url, overriding RESTOptions.baseURL.

---

data?

data?: unknown;

Defined in: packages/rest/src/rest.ts:25

JSON request body.

---

headers?

headers?: Record<string, string>;

Defined in: packages/rest/src/rest.ts:26

---

method?

method?: string;

Defined in: packages/rest/src/rest.ts:21

HTTP method. Defaults to GET.

---

params?

params?: Record<string, QueryValue>;

Defined in: packages/rest/src/rest.ts:23

Query parameters, set on the URL (replacing any of the same name); null/undefined are skipped.

---

signal?

signal?: AbortSignal;

Defined in: packages/rest/src/rest.ts:27