patreon-api.ts

Appearance

Interface: PatreonMockOptions ​

Defined in: schemas/v2/mock/mock.ts:63

Options for mocking the Patreon API.

Properties ​

cache? ​

optional cache: Pick<CacheStoreOptions, "requests" | "initial">

Defined in: schemas/v2/mock/mock.ts:94

Options for the cache. Use a cache to persist your mocking data and act as a mock database.

data? ​

optional data: PatreonMockDataOptions | PatreonMockData

Defined in: schemas/v2/mock/mock.ts:100

Options to return random data. If no cache item is found, the mock service can return a randomly generated payload as response.

responseOptions? ​

optional responseOptions: object

Defined in: schemas/v2/mock/mock.ts:83

Options for replying from the mock service.

headers? ​

optional headers: Record<string, string>

The additional headers to send on every request.

Default ​
ts
{}

validation? ​

optional validation: object

Defined in: schemas/v2/mock/mock.ts:67

Options to validate your requests to the mocking service.

headers? ​

optional headers: string[] | Record<string, string>

The required headers that must be present. If given as an object, the values must also match.

Default ​
ts
[]

query? ​

optional query: boolean

Whether to validate the query to check for correct relationships and attributes requested.

Default ​
ts
false

webhooks? ​

optional webhooks: PatreonMockWebhooksOptions

Defined in: schemas/v2/mock/mock.ts:107

Mock the Patreon webhooks implementation.