Skip to Content
APIPlanning Center Base TSSrcInterfacesInterface: EventEmitter

planning-center-monorepo v1.0.0


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

Interface: EventEmitter

Defined in: packages/planning-center-base-ts/src/types/events.ts:141 

Methods

on()

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:143 

Parameters
eventType

"request:start"

handler

EventHandler<EventRequestStartEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:144 

Parameters
eventType

"request:complete"

handler

EventHandler<EventRequestCompleteEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:145 

Parameters
eventType

"request:error"

handler

EventHandler<RequestErrorEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:146 

Parameters
eventType

"auth:success"

handler

EventHandler<AuthSuccessEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:147 

Parameters
eventType

"auth:failure"

handler

EventHandler<EventAuthFailureEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:148 

Parameters
eventType

"auth:refresh"

handler

EventHandler<AuthRefreshEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:149 

Parameters
eventType

"rate:limit"

handler

EventHandler<EventRateLimitEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:150 

Parameters
eventType

"rate:available"

handler

EventHandler<RateAvailableEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:151 

Parameters
eventType

"cache:hit"

handler

EventHandler<CacheHitEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:152 

Parameters
eventType

"cache:miss"

handler

EventHandler<CacheMissEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:153 

Parameters
eventType

"cache:set"

handler

EventHandler<CacheSetEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:154 

Parameters
eventType

"cache:invalidate"

handler

EventHandler<CacheInvalidateEvent>

Returns

void

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:155 

Parameters
eventType

"error"

handler

EventHandler<EventErrorEvent>

Returns

void

Call Signature

on<T>(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:157 

Type Parameters
T

T extends PcoEvent

Parameters
eventType

T["type"]

handler

EventHandler<T>

Returns

void


off()

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:159 

Parameters
eventType

"request:start"

handler

EventHandler<EventRequestStartEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:160 

Parameters
eventType

"request:complete"

handler

EventHandler<EventRequestCompleteEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:161 

Parameters
eventType

"request:error"

handler

EventHandler<RequestErrorEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:162 

Parameters
eventType

"auth:success"

handler

EventHandler<AuthSuccessEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:163 

Parameters
eventType

"auth:failure"

handler

EventHandler<EventAuthFailureEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:164 

Parameters
eventType

"auth:refresh"

handler

EventHandler<AuthRefreshEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:165 

Parameters
eventType

"rate:limit"

handler

EventHandler<EventRateLimitEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:166 

Parameters
eventType

"rate:available"

handler

EventHandler<RateAvailableEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:167 

Parameters
eventType

"cache:hit"

handler

EventHandler<CacheHitEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:168 

Parameters
eventType

"cache:miss"

handler

EventHandler<CacheMissEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:169 

Parameters
eventType

"cache:set"

handler

EventHandler<CacheSetEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:170 

Parameters
eventType

"cache:invalidate"

handler

EventHandler<CacheInvalidateEvent>

Returns

void

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:171 

Parameters
eventType

"error"

handler

EventHandler<EventErrorEvent>

Returns

void

Call Signature

off<T>(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:173 

Type Parameters
T

T extends PcoEvent

Parameters
eventType

T["type"]

handler

EventHandler<T>

Returns

void


emit()

emit<T>(event): void

Defined in: packages/planning-center-base-ts/src/types/events.ts:175 

Type Parameters

T

T extends PcoEvent

Parameters

event

T

Returns

void