Skip to main content

Variable: optionMatchers

const optionMatchers: object

Defined in: testing/matchers/option.ts:206

All Option matchers as a single object for easy extension.

Type Declaration​

toBeNone​

toBeNone: MatcherFunction

Assert that an Option is None.

Example​

import { expect } from 'vitest'
import { some, none } from 'receta/option'

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

toBeSome​

toBeSome: MatcherFunction

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

Example​

import { expect } from 'vitest'
import { some, none } from 'receta/option'

expect(some(5)).toBeSome()           // Pass
expect(some(5)).toBeSome(5)          // Pass
expect(some(5)).toBeSome(10)         // Fail
expect(none()).not.toBeSome()        // Pass

toEqualOption​

toEqualOption: MatcherFunction

Deep equality check for Option types.

Example​

import { expect } from 'vitest'
import { some, none } from 'receta/option'

expect(some(5)).toEqualOption(some(5))   // Pass
expect(none()).toEqualOption(none())     // Pass
expect(some(5)).toEqualOption(some(10))  // Fail
expect(some(5)).toEqualOption(none())    // Fail

Example​

import { expect } from 'vitest'
import { optionMatchers } from 'receta-test/matchers'

expect.extend(optionMatchers)