Skip to content

EventList

A list associated with an event query.

Constructors

Constructor

new EventList(book, payload): EventList;

Parameters

ParameterType
bookBook
payloadEventList

Returns

EventList

Methods

getCursor()

getCursor(): string | undefined;

Gets the cursor associated with the query for pagination.

Returns

string | undefined

The cursor associated with the query for pagination


getFirst()

getFirst(): Event | undefined;

Gets the first Event in the list.

Returns

Event | undefined

The first Event in the list


getItems()

getItems(): Event[];

Get the events in the list.

Returns

Event[]

An array of Event objects


size()

size(): number;

Get the total number of events in the list.

Returns

number

The total number of events