> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: ScenarioExpectation<T>

> Not exported: an exported type refers to it.

[scenarios](/api/modules/scenarios).ScenarioExpectation

Not exported: an exported type refers to it.

## Type parameters

| Name |
| :- |
| `T` |

## Constructors

### constructor

• **new ScenarioExpectation**\<`T`>(`builder`, `id`, `actual`)

#### Type parameters

| Name |
| :- |
| `T` |

#### Parameters

| Name | Type |
| :- | :- |
| `builder` | [`ScenarioBuilder`](/api/classes/scenarios.ScenarioBuilder) |
| `id` | `string` |
| `actual` | [`ScenarioInput`](/api/modules/scenarios#scenarioinput)\<`T`> |

## Properties

### builder

• `Private` `Readonly` **builder**: [`ScenarioBuilder`](/api/classes/scenarios.ScenarioBuilder)

***

### id

• `Private` `Readonly` **id**: `string`

***

### actual

• `Private` `Readonly` **actual**: [`ScenarioInput`](/api/modules/scenarios#scenarioinput)\<`T`>

## Methods

### toEqual

▸ **toEqual**(`expected`): `void`

#### Parameters

| Name | Type |
| :- | :- |
| `expected` | [`ScenarioInput`](/api/modules/scenarios#scenarioinput)\<`T`> |

#### Returns

`void`

***

### toBeAtLeast

▸ **toBeAtLeast**(`this`, `expected`): `void`

#### Parameters

| Name | Type |
| :- | :- |
| `this` | [`ScenarioExpectation`](/api/classes/scenarios.ScenarioExpectation)\<`bigint`> |
| `expected` | [`ScenarioInput`](/api/modules/scenarios#scenarioinput)\<`bigint`> |

#### Returns

`void`

***

### toBeAtMost

▸ **toBeAtMost**(`this`, `expected`): `void`

#### Parameters

| Name | Type |
| :- | :- |
| `this` | [`ScenarioExpectation`](/api/classes/scenarios.ScenarioExpectation)\<`bigint`> |
| `expected` | [`ScenarioInput`](/api/modules/scenarios#scenarioinput)\<`bigint`> |

#### Returns

`void`

***

### add

▸ `Private` **add**(`comparison`, `expected`): `void`

#### Parameters

| Name | Type |
| :- | :- |
| `comparison` | `"equal"` \| `"at_least"` \| `"at_most"` |
| `expected` | [`ScenarioInput`](/api/modules/scenarios#scenarioinput)\<`T`> |

#### Returns

`void`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.