Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / PersEventEmitter

Class: PersEventEmitter

Table of contents

Accessors

Constructors

Methods

Accessors

instanceId

• get instanceId(): number

Returns

number

Defined in

core/events/event-emitter.ts:88


subscriberCount

• get subscriberCount(): number

Get count of active subscriptions

Returns

number

Defined in

core/events/event-emitter.ts:298

Constructors

constructor

• new PersEventEmitter(): PersEventEmitter

Returns

PersEventEmitter

Defined in

core/events/event-emitter.ts:84

Methods

subscribe

▸ subscribe(handler, filter?): Unsubscribe

Subscribe to events

Parameters

NameTypeDescription
handlerEventHandlerCallback for matching events
filter?EventFilterOptional filter by domain and/or level. Set replay: true to receive last auth event if missed.

Returns

Unsubscribe

Unsubscribe function

Example

const unsub = sdk.events.subscribe((event) => {
  console.log(`[${event.domain}] ${event.type}: ${event.userMessage}`);
});

Example

sdk.events.subscribe((event) => {
  logToSentry(event);
}, { levels: ['error'] });

Example

sdk.events.subscribe((event) => {
  playSuccessSound();
  confetti();
}, { domains: ['transaction'], levels: ['success'] });

Example

sdk.events.subscribe((event) => {
  if (event.type === 'session_restored') {
    const { user } = event.details;
    setUser(user);
  }
}, { domains: ['authentication'], replay: true });

Defined in

core/events/event-emitter.ts:132


once

▸ once(handler, filter?): Unsubscribe

Subscribe and auto-unsubscribe after first matching event

Parameters

NameTypeDescription
handlerEventHandlerCallback for the first matching event
filter?EventFilterOptional filter by domain and/or level

Returns

Unsubscribe

Unsubscribe function

Defined in

core/events/event-emitter.ts:161


emitSuccess

▸ emitSuccess(event): SuccessEvent

Emit a success event

Domain is restricted to business domains only (Domain type). Auth events (login_success, session_restored) are cached for replay to late subscribers.

Parameters

NameTypeDescription
eventSuccessEventInputSuccess event data (id and timestamp auto-generated)

Returns

SuccessEvent

The complete event object

Example

sdk.events.emitSuccess({
  domain: 'transaction',  // Only business domains allowed
  type: 'transaction_confirmed',
  userMessage: 'Transaction confirmed!'
});

Defined in

core/events/event-emitter.ts:191


emitError

▸ emitError(event): ErrorEvent

Emit an error event

Domain can be any domain including technical (ErrorDomain type).

Parameters

NameTypeDescription
eventErrorEventInputError event data (id and timestamp auto-generated)

Returns

ErrorEvent

The complete event object

Example

sdk.events.emitError({
  domain: 'validation',  // Technical domains allowed
  type: 'validation_failed',
  userMessage: 'Please check your input'
});

Defined in

core/events/event-emitter.ts:231


clear

▸ clear(): void

Remove all handlers

Returns

void

Defined in

core/events/event-emitter.ts:291