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

webrequest¶

Functions¶

getRateLimitStatus()¶

getRateLimitStatus(): TbRatelimitStatusResponse

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

Returns a serializable snapshot of the shared rate-limit budget. Infinity (no limit observed) does not survive the message channel, so it maps to null.

Returns¶

TbRatelimitStatusResponse

makeRequest()¶

makeRequest(__namedParameters): Promise<Response>

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

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:489

Registers the toolbox-request message handler that proxies fetch calls, and the toolbox-ratelimit-status handler that reports the shared budget.

Returns¶

void

Interfaces¶

MakeRequestOptions¶

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

Options accepted by makeRequest.

Properties¶

absolute?¶

optional absolute?: boolean

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

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:315

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

container?¶

optional container?: ContainerTarget

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

Firefox container tab that originated the request; its frame performs the network call so the container’s cookies are sent. Derived from the trusted message sender, never from content-script-supplied payload data.

endpoint¶

endpoint: string

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

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

method?¶

optional method?: string

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

HTTP method; defaults to GET.

oauth?¶

optional oauth?: boolean

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

If true, targets oauth.reddit.com and authenticates with either the session cookie or a bearer token depending on the endpoint; reads that get a 403 are retried once with the other.

okOnly?¶

optional okOnly?: boolean

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

If true, throws for non-2xx responses.

query?¶

optional query?: Record<string, QueryValue>

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

Query parameters to append to the URL.