Skip to Content
APIPlanning Center Base TSSrcClassesClass: PcoHttpClient

planning-center-monorepo v1.0.0


planning-center-monorepo / planning-center-base-ts/src / PcoHttpClient

Class: PcoHttpClient

Defined in: packages/planning-center-base-ts/src/http-client.ts:30 

Constructors

Constructor

new PcoHttpClient(config, eventEmitter): PcoHttpClient

Defined in: packages/planning-center-base-ts/src/http-client.ts:38 

Parameters

config

PcoClientConfig

eventEmitter

PcoEventEmitter

Returns

PcoHttpClient

Methods

request()

request<T>(options): Promise<HttpResponse<T>>

Defined in: packages/planning-center-base-ts/src/http-client.ts:55 

Type Parameters

T

T = any

Parameters

options

HttpRequestOptions

Returns

Promise<HttpResponse<T>>


getPerformanceMetrics()

getPerformanceMetrics(): Record<string, { count: number; averageTime: number; minTime: number; maxTime: number; errorRate: number; }>

Defined in: packages/planning-center-base-ts/src/http-client.ts:545 

Returns

Record<string, { count: number; averageTime: number; minTime: number; maxTime: number; errorRate: number; }>


getRateLimitInfo()

getRateLimitInfo(): Record<string, { limit: number; remaining: number; resetTime: number; }>

Defined in: packages/planning-center-base-ts/src/http-client.ts:549 

Returns

Record<string, { limit: number; remaining: number; resetTime: number; }>


getAuthHeader()

getAuthHeader(): string

Defined in: packages/planning-center-base-ts/src/http-client.ts:557 

Get authentication header for external services (like file uploads). Uses the same auth as the main API so upload.planningcenteronline.com accepts it.

Returns

string