@nomicfoundation/hardhat-chai-matchers
Version:
Hardhat utils for testing
20 lines • 1.17 kB
TypeScript
export type Ssfi = (...args: any[]) => any;
/**
* This function is used by the matchers to obtain an `assert` function, which
* should be used instead of `this.assert`.
*
* The first parameter is the value of the `negated` flag. Keep in mind that
* this value should be captured at the beginning of the matcher's
* implementation, before any async code is executed. Otherwise things like
* `.to.emit().and.not.to.emit()` won't work, because by the time the async part
* of the first emit is executd, the `.not` (executed synchronously) has already
* modified the flag.
*
* The second parameter is what Chai calls the "start stack function indicator",
* a function that is used to build the stack trace. It's unclear to us what's
* the best way to use this value, so this needs some trial-and-error. Use the
* existing matchers for a reference of something that works well enough.
*/
export declare function buildAssert(negated: boolean, ssfi: Ssfi): (condition: boolean, messageFalse?: string | (() => string), messageTrue?: string | (() => string)) => void;
export type AssertWithSsfi = ReturnType<typeof buildAssert>;
//# sourceMappingURL=utils.d.ts.map