patreon-api.ts

Appearance

Interface: Oauth2FetchOptions ​

Defined in: rest/v2/clients/baseMethods.ts:38

Options for the raw Oauth2 request methods

Extends ​

  • BaseFetchOptions

Properties ​

api? ​

optional api: string

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

The base url of the Patreon API

Default ​

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

Inherited from ​

BaseFetchOptions.api

auth? ​

optional auth: boolean

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

Whether this request should include an authorization header

Default ​

ts
true

Inherited from ​

BaseFetchOptions.auth

authPrefix? ​

optional authPrefix: string

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

The authentication prefix for this request to use

Default ​

ts
'Bearer'

Inherited from ​

BaseFetchOptions.authPrefix

body? ​

optional body: string

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

The stringified request body

Default ​

ts
undefined

Inherited from ​

BaseFetchOptions.body

fetch? ​

optional fetch: RestFetcher

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

The fetch function to use for making this request

Default ​

ts
globalThis.fetch

Inherited from ​

BaseFetchOptions.fetch

headers? ​

optional headers: Record<string, string>

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

Headers to add on this request

Default ​

ts
{}

Inherited from ​

BaseFetchOptions.headers

method? ​

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

Defined in: rest/v2/clients/baseMethods.ts:50

Overwrite the method of the request. If you are using a function to write, update or delete resources this will be already set.

Default ​

ts
'GET'

signal? ​

optional signal: AbortSignal

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

The abort signal for this request

Default ​

ts
undefined

Inherited from ​

BaseFetchOptions.signal

timeout? ​

optional timeout: number

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

The time in ms after the request will be aborted

Default ​

ts
15_000

Inherited from ​

BaseFetchOptions.timeout

token? ​

optional token: string | Oauth2CreatorToken | Oauth2StoredToken

Defined in: rest/v2/clients/baseMethods.ts:43

Overwrite the client token with a new (access) token

Default ​

ts
undefined