56 lines
1.7 KiB
TypeScript
56 lines
1.7 KiB
TypeScript
import { Assertion, AnyMatcher, AnythingMatcher } from './smartexpect.classes.assertion.js';
|
|
// import type { TMatcher } from './smartexpect.classes.assertion.js'; // unused
|
|
|
|
/**
|
|
* Primary entry point for assertions.
|
|
* Automatically detects Promises to support async assertions.
|
|
*/
|
|
/**
|
|
* The `expect` function interface. Supports custom matchers via .extend.
|
|
*/
|
|
/**
|
|
* Entry point for assertions.
|
|
* Automatically detects Promises to support async assertions.
|
|
*/
|
|
export function expect<T>(value: Promise<T>): Assertion<T>;
|
|
export function expect<T>(value: T): Assertion<T>;
|
|
export function expect<T>(value: any): Assertion<T> {
|
|
const isThenable = value != null && typeof (value as any).then === 'function';
|
|
const mode: 'sync' | 'async' = isThenable ? 'async' : 'sync';
|
|
return new Assertion<T>(value, mode);
|
|
}
|
|
/**
|
|
* Register custom matchers.
|
|
*/
|
|
export namespace expect {
|
|
export const extend = Assertion.extend;
|
|
/**
|
|
* Matcher for a specific constructor. Passes if value is instance of given constructor.
|
|
*/
|
|
export function any(constructor: any) {
|
|
return new AnyMatcher(constructor);
|
|
}
|
|
/**
|
|
* Matcher for any defined value (not null or undefined).
|
|
*/
|
|
export function anything() {
|
|
return new AnythingMatcher();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @deprecated Use `expect(...)` with `.resolves` or `.rejects` instead.
|
|
*/
|
|
/**
|
|
* @deprecated Use `expect(...)` with `.resolves` or `.rejects` instead.
|
|
*/
|
|
/**
|
|
* @deprecated Use `expect(...)` with `.resolves` or `.rejects` instead.
|
|
*/
|
|
export const expectAsync = (baseArg: any) => {
|
|
// eslint-disable-next-line no-console
|
|
console.warn('[DEPRECATED] expectAsync() is deprecated. Use expect(...).resolves / .rejects');
|
|
return new Assertion<any>(baseArg, 'async');
|
|
};
|
|
|