Interface: Oauth2FetchOptions
Defined in: clients/v2/shared.ts:32
Options for the raw Oauth2 request methods
Extends
Omit<RequestOptions,"route"|"accessToken"|"query">
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
api? | string | The base url of the Patreon API Default 'https://www.patreon.com/api/oauth2/v2' | RequestOptions.api |
auth? | boolean | Whether this request should include an authorization header Default true | RequestOptions.auth |
authPrefix? | string | The authentication prefix for this request to use Default 'Bearer' | RequestOptions.authPrefix |
body? | string | The stringified request body Default undefined | RequestOptions.body |
fetch? | RestFetcher | The fetch function to use for making this request Default globalThis.fetch | RequestOptions.fetch |
headers? | Record<string, string> | Headers to add on this request Default {} | RequestOptions.headers |
method? | "DELETE" | "GET" | "PATCH" | "POST" | RequestMethod | Overwrite the method of the request. If you are using a function to write, update or delete resources this will be already set. Default 'GET' | - |
signal? | AbortSignal | The abort signal for this request Default undefined | RequestOptions.signal |
timeout? | number | The time in ms after the request will be aborted Default 15_000 | RequestOptions.timeout |
token? | string | Oauth2CreatorToken | Oauth2StoredToken | Overwrite the client token with a new (access) token Default undefined | - |