moderator-toolbox-nxg-for-reddit / background/handlers/webrequest

background/handlers/webrequest¶

Functions¶

makeRequest()¶

makeRequest(__namedParameters): Promise<Response>

Defined in: extension/data/background/handlers/webrequest.ts:293

Performs an arbitrary HTTP request on behalf of the extension.

Parameters¶

__namedParameters¶

MakeRequestOptions

Returns¶

Promise<Response>

registerWebrequestHandlers()¶

registerWebrequestHandlers(): void

Defined in: extension/data/background/handlers/webrequest.ts:400

Registers the toolbox-request message handler that proxies fetch calls.

Returns¶

void

Interfaces¶

MakeRequestOptions¶

Defined in: extension/data/background/handlers/webrequest.ts:262

Options accepted by makeRequest.

Properties¶

absolute?¶

optional absolute?: boolean

Defined in: extension/data/background/handlers/webrequest.ts:276

If true, treats endpoint as a fully-qualified URL. Must target a reddit.com origin.

body?¶

optional body?: string | RequestBodyObject | { data: unknown; type: "json"; }

Defined in: extension/data/background/handlers/webrequest.ts:270

Request body; objects are form-encoded, strings are sent as-is, {type:'json'} is JSON-encoded.

cookieStoreId?¶

optional cookieStoreId?: string

Defined in: extension/data/background/handlers/webrequest.ts:282

Cookie store of the tab that originated the request, used to send the right Firefox container’s cookies. Derived from the trusted message sender, never from content-script-supplied payload data.

endpoint¶

endpoint: string

Defined in: extension/data/background/handlers/webrequest.ts:266

API endpoint path, or a fully-qualified URL when absolute is true.

method?¶

optional method?: string

Defined in: extension/data/background/handlers/webrequest.ts:264

HTTP method; defaults to GET.

oauth?¶

optional oauth?: boolean

Defined in: extension/data/background/handlers/webrequest.ts:272

If true, attaches a Reddit OAuth bearer token and targets oauth.reddit.com.

okOnly?¶

optional okOnly?: boolean

Defined in: extension/data/background/handlers/webrequest.ts:274

If true, throws for non-2xx responses.

query?¶

optional query?: Record<string, QueryValue>

Defined in: extension/data/background/handlers/webrequest.ts:268

Query parameters to append to the URL.