Skip to main content
Version: 1.x

Interface: MatcherResult

Result of a matcher check.

Example​

const result: MatcherResult = {
  pass: true,
  message: () => 'Expected text to match',
  actual: 'Save',
  expected: 'Save',
};

Properties​

actual?​

readonly optional actual: unknown

expected?​

readonly optional expected: unknown

message()​

readonly message: () => string

Returns a human-readable description of the match outcome.

Returns​

string

pass​

readonly pass: boolean