Interface: PatreonClientOptions<IncludeAll>

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

The constructor options for API applications

Type Parameters

IncludeAll

IncludeAll extends boolean = false

Properties

name?

optional name: string

Defined in: rest/v2/clients/base.ts:53

The application name of this client

---

oauth

oauth: PatreonOauthClientOptions

Defined in: rest/v2/clients/base.ts:48

The Oauth options for this client. Required for both creator and user clients.

---

rest?

optional rest: Partial<RESTOptions<IncludeAll>>

Defined in: rest/v2/clients/base.ts:58

The rest options for this client

---

store?

optional store: PatreonTokenFetchOptions

Defined in: rest/v2/clients/base.ts:64

Options for storing and getting API (creator) tokens.

Default

undefined