tryError Documentation

Class: ErrorEventEmitter
Class

Defined in: [events.ts:51](https://github.com/oconnorjohnson/try-error/blob/e3ae0308069a4fba073f4543d527ad76373db795/src/events.ts#L51) Event emitter for error lifecycle

tryError API Documentation v0.0.1-alpha.1


tryError API Documentation / ErrorEventEmitter

Class: ErrorEventEmitter

Defined in: events.ts:51

Event emitter for error lifecycle

Constructors

Constructor

new ErrorEventEmitter(): ErrorEventEmitter;

Returns

ErrorEventEmitter

Methods

clear()

clear(): void;

Defined in: events.ts:180

Clear all listeners

Returns

void


emit()

emit(event): void;

Defined in: events.ts:118

Emit an event

Parameters

event

ErrorEvent

Returns

void


getListenerCount()

getListenerCount(eventType?): number;

Defined in: events.ts:189

Get listener count

Parameters

eventType?

"error:created" | "error:transformed" | "error:pooled" | "error:released" | "error:serialized" | "error:wrapped" | "error:retry" | "error:recovered"

Returns

number


off()

off(eventType, listener): void;

Defined in: events.ts:104

Unsubscribe from a specific event type

Parameters

eventType

"error:created" | "error:transformed" | "error:pooled" | "error:released" | "error:serialized" | "error:wrapped" | "error:retry" | "error:recovered"

listener

ErrorEventListener

Returns

void


offAll()

offAll(listener): void;

Defined in: events.ts:111

Unsubscribe from all events

Parameters

listener

ErrorEventListener

Returns

void


on()

on(eventType, listener): () => void;

Defined in: events.ts:61

Subscribe to a specific event type

Parameters

eventType

"error:created" | "error:transformed" | "error:pooled" | "error:released" | "error:serialized" | "error:wrapped" | "error:retry" | "error:recovered"

listener

ErrorEventListener

Returns

(): void;
Returns

void


onAll()

onAll(listener): () => void;

Defined in: events.ts:76

Subscribe to all events

Parameters

listener

ErrorEventListener

Returns

(): void;
Returns

void


once()

once(eventType, listener): () => void;

Defined in: events.ts:88

Subscribe to an event once

Parameters

eventType

"error:created" | "error:transformed" | "error:pooled" | "error:released" | "error:serialized" | "error:wrapped" | "error:retry" | "error:recovered"

listener

ErrorEventListener

Returns

(): void;
Returns

void