Type Alias MainRequestOptions

Main options of a request.

type MainRequestOptions = {
    body?: string | boolean | number | object | null;
    contentType?: string;
    extraRequestInit?: ExtraRequestInit;
    method?: string;
    params?: URLSearchParamsRecord;
    path: string;
}

Index

Properties

body? contentType? extraRequestInit? method? params? path

Properties

`Optional`body

body?: string | boolean | number | object | null

The body of the request.

Remarks

This only really supports string for now (any other type gets stringified) but it could support more in the future. https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#body

`Optional`contentType

contentType?: string

Content-Type passed to request Headers.

`Optional`extraRequestInit

extraRequestInit?: ExtraRequestInit

An extra, more limited RequestInit, that may override some of the options.

`Optional`method

method?: string

The REST method of the request.

`Optional`params

params?: URLSearchParamsRecord

The search parameters of the URL.

path

path: string

The path or subpath of the URL to make a request to.