@xylabs/vitest-matchers

@xylabs/vitest-matchers

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/vitest-matchers

Interfaces

Interface	Description
ExpectationResult	Result returned by a custom matcher function.

Variables

Variable	Description
matchers	Collection of custom Vitest matchers extending the built-in expect assertions.

interfaces

ExpectationResult

@xylabs/vitest-matchers

Result returned by a custom matcher function.

Properties

Property	Type	Description
actual?	unknown	The actual value received by the matcher.
expected?	unknown	The expected value the matcher compared against.
message	() => string	Returns a human-readable failure or negation message.
pass	boolean	Whether the matcher assertion passed.

variables

matchers

@xylabs/vitest-matchers

const matchers: {
  toBeArrayOfSize: ExpectationResult;
  toBeArray: ExpectationResult;
  toBeOneOf: ExpectationResult;
  toBeNegative: ExpectationResult;
  toBePositive: ExpectationResult;
  toBeNumber: (received: unknown) => ExpectationResult;
  toBeFunction: (received: unknown) => ExpectationResult;
  toBeString: (received: unknown) => ExpectationResult;
  toBeObject: ExpectationResult;
  toBeInteger: ExpectationResult;
  toBeFalse: ExpectationResult;
  toBeTrue: ExpectationResult;
  toContainAllValues: {
     pass: boolean;
     message: () => string;
  };
  toContainKey: {
     pass: boolean;
     message: () => string;
  };
  toInclude: {
     pass: boolean;
     message: () => string;
  };
  toIncludeAllMembers: ExpectationResult;
  toContainAllKeys: ExpectationResult;
  toContainValues: ExpectationResult;
  toBeEmpty: ExpectationResult;
  toBeValidDate: {
     pass: boolean;
     message: () => string;
  };
};

Collection of custom Vitest matchers extending the built-in expect assertions.

Type Declaration

Name	Type	Description
toBeArrayOfSize()	(received: unknown, expectedSize: number) => ExpectationResult	Asserts the received value is an array with the specified length.
toBeArray()	(received: unknown) => ExpectationResult	Asserts the received value is an array.
toBeOneOf()	(received: unknown, expected: unknown[]) => ExpectationResult	Asserts the received value is one of the values in the expected array.
toBeNegative()	(received: number) => ExpectationResult	Asserts the received number is negative (less than zero).
toBePositive()	(received: number) => ExpectationResult	Asserts the received number is positive (greater than zero).
toBeNumber()	(received: unknown) => ExpectationResult	Asserts the received value is of type number and not NaN.
toBeFunction()	(received: unknown) => ExpectationResult	Asserts the received value is of type function.
toBeString()	(received: unknown) => ExpectationResult	Asserts the received value is of type string.
toBeObject()	(received: unknown) => ExpectationResult	Asserts the received value is a plain object (not an array or null).
toBeInteger()	(received: number) => ExpectationResult	Asserts the received number is an integer.
toBeFalse()	(received: unknown) => ExpectationResult	Asserts the received value is strictly false.
toBeTrue()	(received: unknown) => ExpectationResult	Asserts the received value is strictly true.
toContainAllValues()	(received: unknown, expectedValues: unknown[]) => { pass: boolean; message: () => string; }	Asserts that all expected values are present in the received array or object values.
toContainKey()	(received: object, key: string) => { pass: boolean; message: () => string; }	Asserts that the received object contains the specified key.
toInclude()	(received: unknown, value: any) => { pass: boolean; message: () => string; }	Asserts that the received array, string, or object values include the specified value.
toIncludeAllMembers()	(received: unknown[], expected: unknown[]) => ExpectationResult	Asserts that the received array includes all members of the expected array.
toContainAllKeys()	(received: object, expectedKeys: string[]) => ExpectationResult	Asserts that the received object contains all of the specified keys.
toContainValues()	(received: object, expectedValues: unknown[]) => ExpectationResult	Asserts that the received object contains all of the specified values (using deep equality).
toBeEmpty()	(received: unknown) => ExpectationResult	Asserts the received value is empty (zero-length array/string, empty object, or empty Map/Set).
toBeValidDate()	(received: unknown) => { pass: boolean; message: () => string; }	Asserts the received value is a valid Date instance (not an invalid date).

Part of sdk-js

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs