@ariestools/vitest-matchers
Advanced tools
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
Using npm:
npm install {{name}}
Using yarn:
yarn add {{name}}
Using pnpm:
pnpm add {{name}}
Using bun:
bun add {{name}}
See the LICENSE file for license rights and limitations (LGPL-3.0-only).
### .temp-typedoc
### interfaces
### <a id="ExpectationResult"></a>ExpectationResult
Result returned by a custom matcher function.
optional actual?: unknown;
The actual value received by the matcher.
optional expected?: unknown;
The expected value the matcher compared against.
message: () => string;
Returns a human-readable failure or negation message.
string
pass: boolean;
Whether the matcher assertion passed.
### variables
### <a id="matchers"></a>matchers
const matchers: object;
Collection of custom Vitest matchers extending the built-in expect assertions.
toBeArrayOfSize(received, expectedSize): ExpectationResult;
Asserts the received value is an array with the specified length.
unknown
The value to check.
number
The expected array length.
toBeArray(received): ExpectationResult;
Asserts the received value is an array.
unknown
The value to check.
toBeOneOf(received, expected): ExpectationResult;
Asserts the received value is one of the values in the expected array.
unknown
The value to check.
unknown[]
The array of acceptable values.
toBeNegative(received): ExpectationResult;
Asserts the received number is negative (less than zero).
number
The number to check.
toBePositive(received): ExpectationResult;
Asserts the received number is positive (greater than zero).
number
The number to check.
toBeNumber: (received) => ExpectationResult;
Asserts the received value is of type number and not NaN.
unknown
The value to check.
toBeFunction: (received) => ExpectationResult;
Asserts the received value is of type function.
unknown
The value to check.
toBeString: (received) => ExpectationResult;
Asserts the received value is of type string.
unknown
The value to check.
toBeObject(received): ExpectationResult;
Asserts the received value is a plain object (not an array or null).
unknown
The value to check.
toBeInteger(received): ExpectationResult;
Asserts the received number is an integer.
number
The number to check.
toBeFalse(received): ExpectationResult;
Asserts the received value is strictly false.
unknown
The value to check.
toBeTrue(received): ExpectationResult;
Asserts the received value is strictly true.
unknown
The value to check.
toContainAllValues(received, expectedValues): object;
Asserts that all expected values are present in the received array or object values.
unknown
The array or object to check.
unknown[]
The values that must all be present.
object
pass: boolean = false;
message: () => string;
string
toContainKey(received, key): object;
Asserts that the received object contains the specified key.
object
The object to check.
string
The key that should be present.
object
pass: boolean = true;
message: () => string;
string
toInclude(received, value): object;
Asserts that the received array, string, or object values include the specified value.
unknown
The array, string, or object to search within.
any
The value to look for.
object
pass: boolean;
message: () => string;
string
toIncludeAllMembers(received, expected): ExpectationResult;
Asserts that the received array includes all members of the expected array.
unknown[]
The array to check.
unknown[]
The members that must all be present.
toContainAllKeys(received, expectedKeys): ExpectationResult;
Asserts that the received object contains all of the specified keys.
object
The object to check.
string[]
The keys that must all be present.
toContainValues(received, expectedValues): ExpectationResult;
Asserts that the received object contains all of the specified values (using deep equality).
object
The object to check.
unknown[]
The values that must all be present.
toBeEmpty(received): ExpectationResult;
Asserts the received value is empty (zero-length array/string, empty object, or empty Map/Set).
unknown
The value to check.
toBeValidDate(received): object;
Asserts the received value is a valid Date instance (not an invalid date).
unknown
The value to check.
object
pass: boolean = isValid;
message: () => string;
string
FAQs
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
We found that @ariestools/vitest-matchers demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A malicious .NET package is typosquatting the Braintree SDK to steal live payment card data, merchant API keys, and host secrets from production apps.
Security News
/Research
Compromised Injective SDK npm version 1.20.21 exfiltrates wallet private keys and mnemonics through fake telemetry functionality.
Security News
npm v12 is generally available, turning install scripts off by default and beginning the deprecation of 2FA-bypass publishing tokens.