patreon-api.ts

Appearance

Interface: InternalRequestOptions ​

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

Extends ​

Properties ​

accessToken? ​

optional accessToken: string

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

For authenticated requests, the token to use.

Default ​

ts
undefined

Throws ​

if the request is authenticated but no token is given

Inherited from ​

RequestOptions.accessToken

api? ​

optional api: string

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

The base url of the Patreon API

Default ​

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

Inherited from ​

RequestOptions.api

auth? ​

optional auth: boolean

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

Whether this request should include an authorization header

Default ​

ts
true

Inherited from ​

RequestOptions.auth

authPrefix? ​

optional authPrefix: string

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

The authentication prefix for this request to use

Default ​

ts
'Bearer'

Inherited from ​

RequestOptions.authPrefix

body? ​

optional body: string

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

The stringified request body

Default ​

ts
undefined

Inherited from ​

RequestOptions.body

fetch? ​

optional fetch: RestFetcher

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

The fetch function to use for making this request

Default ​

ts
globalThis.fetch

Inherited from ​

RequestOptions.fetch

headers? ​

optional headers: Record<string, string>

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

Headers to add on this request

Default ​

ts
{}

Inherited from ​

RequestOptions.headers

method? ​

optional method: "DELETE" | "GET" | "PATCH" | "POST" | RequestMethod

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

path ​

path: string

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

query? ​

optional query: string

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

The final query string

Default ​

ts
''

Inherited from ​

RequestOptions.query

route? ​

optional route: string

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

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

Default ​

ts
undefined

Inherited from ​

RequestOptions.route

signal? ​

optional signal: AbortSignal

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

The abort signal for this request

Default ​

ts
undefined

Inherited from ​

RequestOptions.signal

timeout? ​

optional timeout: number

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

The time in ms after the request will be aborted

Default ​

ts
15_000

Inherited from ​

RequestOptions.timeout