planning-center-monorepo / planning-center-check-ins-ts/src / PcoCheckInsClientConfig

Interface: PcoCheckInsClientConfig

Defined in: packages/planning-center-check-ins-ts/src/types/client.ts:11

Configuration for the Check-Ins API client Extends the base client config with check-ins specific defaults

Extends

Omit<PcoClientConfig, "baseURL">

Properties

auth

auth: PcoAuthConfig

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:37

Authentication configuration

Inherited from

PcoClientConfig.auth

caching?

optional caching: object

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:39

Caching configuration

fieldDefinitions?

optional fieldDefinitions: boolean

ttl?

optional ttl: number

maxSize?

optional maxSize: number

Inherited from

PcoClientConfig.caching

retry?

optional retry: object

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:45

Retry configuration

enabled?

optional enabled: boolean

maxRetries?

optional maxRetries: number

baseDelay?

optional baseDelay: number

maxDelay?

optional maxDelay: number

backoff?

optional backoff: "linear" | "exponential"

Inherited from

PcoClientConfig.retry

events?

optional events: object

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:53

Event handlers

onError()?

optional onError: (event) => void | Promise<void>

Parameters

event

ErrorEvent

Returns

void | Promise<void>

onAuthFailure()?

optional onAuthFailure: (event) => void | Promise<void>

Parameters

event

AuthFailureEvent

Returns

void | Promise<void>

onRequestStart()?

optional onRequestStart: (event) => void | Promise<void>

Parameters

event

RequestStartEvent

Returns

void | Promise<void>

onRequestComplete()?

optional onRequestComplete: (event) => void | Promise<void>

Parameters

event

RequestCompleteEvent

Returns

void | Promise<void>

onRateLimit()?

optional onRateLimit: (event) => void | Promise<void>

Parameters

event

RateLimitEvent

Returns

void | Promise<void>

Inherited from

PcoClientConfig.events

timeout?

optional timeout: number

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:63

Request timeout in milliseconds

Inherited from

PcoClientConfig.timeout

headers?

optional headers: Record<string, string>

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:65

Custom headers

Inherited from

PcoClientConfig.headers

debug?

optional debug: boolean | PcoDebugOptions

Defined in: packages/planning-center-base-ts/dist/types/config.d.ts:70

Enable debug logging for all events (requests, auth, rate limit, cache, errors). Can be toggled at runtime via client updateConfig. Shared across all PCO packages.

Inherited from

PcoClientConfig.debug

baseUrl?

optional baseUrl: string

Defined in: packages/planning-center-check-ins-ts/src/types/client.ts:13

Base URL override (defaults to https://api.planningcenteronline.com )