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

Class: PcoEventEmitter

Defined in: packages/planning-center-base-ts/src/monitoring.ts:25

Implements

EventEmitter

Constructors

Constructor

new PcoEventEmitter(): PcoEventEmitter

Returns

PcoEventEmitter

Methods

on()

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:29

Parameters

eventType

"request:start"

handler

EventHandler<EventRequestStartEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

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

Parameters

eventType

"request:complete"

handler

EventHandler<EventRequestCompleteEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:31

Parameters

eventType

"request:error"

handler

EventHandler<RequestErrorEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:32

Parameters

eventType

"auth:success"

handler

EventHandler<AuthSuccessEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:33

Parameters

eventType

"auth:failure"

handler

EventHandler<EventAuthFailureEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:34

Parameters

eventType

"auth:refresh"

handler

EventHandler<AuthRefreshEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:35

Parameters

eventType

"rate:limit"

handler

EventHandler<EventRateLimitEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:36

Parameters

eventType

"rate:available"

handler

EventHandler<RateAvailableEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:37

Parameters

eventType

"cache:hit"

handler

EventHandler<CacheHitEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

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

Parameters

eventType

"cache:miss"

handler

EventHandler<CacheMissEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:39

Parameters

eventType

"cache:set"

handler

EventHandler<CacheSetEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:40

Parameters

eventType

"cache:invalidate"

handler

EventHandler<CacheInvalidateEvent>

Returns

void

Implementation of

EventEmitter.on

Call Signature

on(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:41

Parameters

eventType

"error"

handler

EventHandler<EventErrorEvent>

Returns

void

Implementation of

EventEmitter.on

off()

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:50

Parameters

eventType

"request:start"

handler

EventHandler<EventRequestStartEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:51

Parameters

eventType

"request:complete"

handler

EventHandler<EventRequestCompleteEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:52

Parameters

eventType

"request:error"

handler

EventHandler<RequestErrorEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:53

Parameters

eventType

"auth:success"

handler

EventHandler<AuthSuccessEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:54

Parameters

eventType

"auth:failure"

handler

EventHandler<EventAuthFailureEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

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

Parameters

eventType

"auth:refresh"

handler

EventHandler<AuthRefreshEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:56

Parameters

eventType

"rate:limit"

handler

EventHandler<EventRateLimitEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:57

Parameters

eventType

"rate:available"

handler

EventHandler<RateAvailableEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:58

Parameters

eventType

"cache:hit"

handler

EventHandler<CacheHitEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:59

Parameters

eventType

"cache:miss"

handler

EventHandler<CacheMissEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:60

Parameters

eventType

"cache:set"

handler

EventHandler<CacheSetEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:61

Parameters

eventType

"cache:invalidate"

handler

EventHandler<CacheInvalidateEvent>

Returns

void

Implementation of

EventEmitter.off

Call Signature

off(eventType, handler): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:62

Parameters

eventType

"error"

handler

EventHandler<EventErrorEvent>

Returns

void

Implementation of

EventEmitter.off

emit()

emit<T>(event): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:73

Type Parameters

T

T extends PcoEvent

Parameters

event

T

Returns

void

Implementation of

EventEmitter.emit

removeAllListeners()

removeAllListeners(eventType?): void

Defined in: packages/planning-center-base-ts/src/monitoring.ts:87

Remove all event handlers

Parameters

eventType?

EventType

Returns

void

listenerCount()

listenerCount(eventType): number

Defined in: packages/planning-center-base-ts/src/monitoring.ts:96

Get the number of listeners for an event type

Parameters

eventType

EventType

Returns

number

eventTypes()

eventTypes(): EventType[]

Defined in: packages/planning-center-base-ts/src/monitoring.ts:101

Get all registered event types

Returns

EventType[]