Skip to main content

Interface: OptionMatchers<R>

Defined in: testing/types.ts:48

Extended Vitest matcher interface for Option types.

Extended by​

Type Parameters​

R​

R = unknown

Methods​

toBeNone()​

toBeNone(): R

Defined in: testing/types.ts:70

Assert that an Option is None.

Returns​

R

Example​

expect(none()).toBeNone()
expect(some(5)).not.toBeNone()

toBeSome()​

toBeSome<T>(expectedValue?): R

Defined in: testing/types.ts:59

Assert that an Option is Some, optionally checking the value.

Type Parameters​

T​

T

Parameters​

expectedValue?​

T

Returns​

R

Example​

expect(some(5)).toBeSome()
expect(some(5)).toBeSome(5)
expect(none()).not.toBeSome()

toEqualOption()​

toEqualOption<T>(expected): R

Defined in: testing/types.ts:81

Deep equality check for Option types.

Type Parameters​

T​

T

Parameters​

expected​

unknown

Returns​

R

Example​

expect(some(5)).toEqualOption(some(5))
expect(none()).toEqualOption(none())