Interface: RequestOptions

Defined in: rest/v2/oauth2/rest/options.ts:136

Extended by

• InternalRequestOptions

Properties

accessToken?

optional accessToken: string

Defined in: rest/v2/oauth2/rest/options.ts:172

For authenticated requests, the token to use.

Default

undefined

Throws

if the request is authenticated but no token is given

---

api?

optional api: string

Defined in: rest/v2/oauth2/rest/options.ts:141

The base url of the Patreon API

Default

'https://patreon.com/api/oauth2/v2'

---

auth?

optional auth: boolean

Defined in: rest/v2/oauth2/rest/options.ts:159

Whether this request should include an authorization header

Default

true

---

authPrefix?

optional authPrefix: string

Defined in: rest/v2/oauth2/rest/options.ts:165

The authentication prefix for this request to use

Default

'Bearer'

---

body?

optional body: string

Defined in: rest/v2/oauth2/rest/options.ts:178

The stringified request body

Default

undefined

---

fetch?

optional fetch: RestFetcher

Defined in: rest/v2/oauth2/rest/options.ts:196

The fetch function to use for making this request

Default

globalThis.fetch

---

headers?

optional headers: Record<string, string>

Defined in: rest/v2/oauth2/rest/options.ts:184

Headers to add on this request

Default

{}

---

query?

optional query: string

Defined in: rest/v2/oauth2/rest/options.ts:153

The final query string

Default

''

---

route?

optional route: string

Defined in: rest/v2/oauth2/rest/options.ts:147

Replace the api base, path and query with a different route

Default

undefined

---

signal?

optional signal: AbortSignal

Defined in: rest/v2/oauth2/rest/options.ts:202

The abort signal for this request

Default

undefined

---

timeout?

optional timeout: number

Defined in: rest/v2/oauth2/rest/options.ts:190

The time in ms after the request will be aborted

Default

15_000