planning-center-monorepo / planning-center-people-ts/src / PcoClientConfig

Interface: PcoClientConfig

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

Properties

auth

auth: PcoAuthConfig

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

Authentication configuration

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

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"

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>

baseURL?

optional baseURL: string

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

Base URL override

timeout?

optional timeout: number

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

Request timeout in milliseconds

headers?

optional headers: Record<string, string>

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

Custom 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.