Class EventsBuffer<EventsList>

Exposes API to filter, find events from the events buffer.

Type Parameters

EventsList extends Record<string | symbol | number, any>

Index

Constructors

constructor

Methods

add all size exists find assertEmitted assertEmittedCount assertNotEmitted assertNoneEmitted flush

Constructors

constructor

new EventsBuffer<EventsList extends Record<string | number | symbol, any>>(): EventsBuffer<
EventsList,
>
Type Parameters
- EventsList extends Record<string | number | symbol, any>
Returns EventsBuffer<EventsList>

Methods

add

add<Name extends AllowedEventTypes>(event: Name, data: any): void
Track emitted event
Type Parameters
- Name extends AllowedEventTypes
Parameters
- event: Name
  The event that was emitted
- data: any
  The data passed with the event
Returns void
- Defined in src/events_buffer.ts:47

all

all(): BufferedEventsList<EventsList>[]
Get all the emitted events

Returns BufferedEventsList<EventsList>[]
Array of all buffered events
- Defined in src/events_buffer.ts:56

size

size(): number
Returns the size of captured events

Returns number
The number of captured events
- Defined in src/events_buffer.ts:65

exists

exists<Event extends string | number | symbol | Constructor<any>>(
event: Event,
finder?: EventFinderCallback<EventsList, Event>,
): boolean
Find if an event was emitted
Type Parameters
- Event extends string | number | symbol | Constructor<any>
Parameters
- event: Event
  The event to check for
- Optionalfinder: EventFinderCallback<EventsList, Event>
  Optional callback to filter specific event instances
Returns boolean
True if the event was emitted
- Defined in src/events_buffer.ts:76

find

find<Event extends string | number | symbol | Constructor<any>>(
    event: Event,
    finder?: EventFinderCallback<EventsList, Event>,
):
    | null
    | (
        Event extends keyof EventsList
            ? BufferedEvent<Event<Event>, EventsList[Event<Event>]>
            : Event extends Constructor<A> ? BufferedEvent<Event<Event>, A> : never
    )
Find a specific event
Type Parameters
- Event extends string | number | symbol | Constructor<any>
Parameters
- event: Event
  The event to find
- Optionalfinder: EventFinderCallback<EventsList, Event>
  Optional callback to filter specific event instances
Returns
    | null
    | (
        Event extends keyof EventsList
            ? BufferedEvent<Event<Event>, EventsList[Event<Event>]>
            : Event extends Constructor<A> ? BufferedEvent<Event<Event>, A> : never
    )
The found event or null
- Defined in src/events_buffer.ts:90

assertEmitted

assertEmitted<Event extends string | number | symbol | Constructor<any>>(
event: Event,
finder?: EventFinderCallback<EventsList, Event>,
): void
Assert a given event has been emitted
Type Parameters
- Event extends string | number | symbol | Constructor<any>
Parameters
- event: Event
  The event to assert was emitted
- Optionalfinder: EventFinderCallback<EventsList, Event>
  Optional callback to filter specific event instances
Returns void
Throws
AssertionError if the event was not emitted
- Defined in src/events_buffer.ts:119

assertEmittedCount

assertEmittedCount<Event extends string | number | symbol | Constructor<any>>(
event: Event,
count: number,
): void
Assert number of times an event has been emitted
Type Parameters
- Event extends string | number | symbol | Constructor<any>
Parameters
- event: Event
  The event to check emission count for
- count: number
  The expected number of emissions
Returns void
Throws
AssertionError if the count doesn't match
- Defined in src/events_buffer.ts:147

assertNotEmitted

assertNotEmitted<Event extends string | number | symbol | Constructor<any>>(
event: Event,
finder?: EventFinderCallback<EventsList, Event>,
): void
Assert a given event has been not been emitted
Type Parameters
- Event extends string | number | symbol | Constructor<any>
Parameters
- event: Event
  The event to assert was not emitted
- Optionalfinder: EventFinderCallback<EventsList, Event>
  Optional callback to filter specific event instances
Returns void
Throws
AssertionError if the event was emitted
- Defined in src/events_buffer.ts:173

assertNoneEmitted

assertNoneEmitted(): void
Assert no events have been emitted

Returns void
Throws
AssertionError if any events were emitted
- Defined in src/events_buffer.ts:200

flush

flush(): void
Flush events collected within memory

Returns void
- Defined in src/events_buffer.ts:226

Class EventsBuffer<EventsList>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns EventsBuffer<EventsList>

Methods

add

Type Parameters

Parameters

Returns void

all

Returns BufferedEventsList<EventsList>[]

size

Returns number

exists

Type Parameters

Parameters

Returns boolean

find

Type Parameters

Parameters

Returns | null | ( Event extends keyof EventsList ? BufferedEvent<Event<Event>, EventsList[Event<Event>]> : Event extends Constructor<A> ? BufferedEvent<Event<Event>, A> : never )

assertEmitted

Type Parameters

Parameters

Returns void

Throws

assertEmittedCount

Type Parameters

Parameters

Returns void

Throws

assertNotEmitted

Type Parameters

Parameters

Returns void

Throws

assertNoneEmitted

Returns void

Throws

flush

Returns void

Settings

On This Page

Returns
| null
| (
Event extends keyof EventsList
? BufferedEvent<Event<Event>, EventsList[Event<Event>]>
: Event extends Constructor<A> ? BufferedEvent<Event<Event>, A> : never
)