# EventList

A list associated with an event query.

### Constructor

```ts
new EventList(book, payload): EventList;
```

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `book` | [`Book`](https://bkper.com/docs/api/bkper-js/classes/book.md) |
| `payload` | `EventList` |

#### Returns

`EventList`

### getCursor()

```ts
getCursor(): string | undefined;
```

Gets the cursor associated with the query for pagination.

#### Returns

`string` \| `undefined`

The cursor associated with the query for pagination

***

### getFirst()

```ts
getFirst(): Event | undefined;
```

Gets the first Event in the list.

#### Returns

[`Event`](https://bkper.com/docs/api/bkper-js/classes/event.md) \| `undefined`

The first Event in the list

***

### getItems()

```ts
getItems(): Event[];
```

Get the events in the list.

#### Returns

[`Event`](https://bkper.com/docs/api/bkper-js/classes/event.md)[]

An array of Event objects

***

### size()

```ts
size(): number;
```

Get the total number of events in the list.

#### Returns

`number`

The total number of events