@plugjs/expect5 0.4.2 → 0.4.3

package/dist/expectation/types.cjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../src/expectation/types.ts"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAoDO,SAAS,OAAO,OAA0B;AAC/C,MAAI,UAAU;AAAM,WAAO;AAG3B,QAAM,OAAO,OAAO;AACpB,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO;AAAA,EACX;AAGA,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO;AAEjC,MAAI,iBAAiB;AAAS,WAAO;AACrC,MAAI,OAAQ,MAAc,MAAM,MAAM;AAAY,WAAO;AAEzD,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAK,WAAO;AACjC,MAAI,iBAAiB;AAAK,WAAO;AAGjC,SAAO;AACT;AAGO,SAAS,OACZ,SACA,MACwC;AAC1C,SAAO,OAAO,QAAQ,KAAK,MAAM;AACnC;AAGO,SAAS,WACZ,SACA,MACgD;AAClD,QAAM,EAAE,MAAM,IAAI;AAElB,MAAI,OAAO,KAAK,MAAM;AAAM;AAE5B,QAAM,IAAI,iBAAiB,SAAS,OAAO,SAAS,WAAW,IAAI,GAAG;AACxE;AAOA,SAAS,gBAAgB,OAAiC;AACxD,SAAO,OAAO,eAAe,KAAK,GAAG,aAAa;AACpD;AAGA,SAAS,iBAAiB,OAAyB,QAAwB;AACzE,QAAM,SAAS,OAAO,SAAS,KAC3B,GAAG,OAAO,SAAS,OAAO,GAAG,EAAE,mBAAmB,MAAM,WACxD,OAAO,SAAS,KAAK;AACzB,SAAO,SACH,IAAI,gBAAgB,KAAK,MAAM,YAC/B,IAAI,gBAAgB,KAAK;AAC/B;AAKO,SAAS,oBAAoB,OAAuB;AACzD,QAAM,QAAQ,OAAO,eAAe,KAAK;AACzC,MAAI,CAAE;AAAO,WAAO;AACpB,SAAO,qBAAqB,MAAM,WAAW;AAC/C;AAGO,SAAS,qBAAqB,MAA2B;AAC9D,MAAI,CAAE;AAAM,WAAO;AACnB,MAAI,CAAE,KAAK;AAAM,WAAO;AACxB,SAAO,IAAI,KAAK;AAClB;AAGO,SAAS,eAAe,OAAwB;AACrD,MAAI,UAAU;AAAM,WAAO;AAC3B,MAAI,UAAU;AAAW,WAAO;AAEhC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AACH,UAAI,MAAM,SAAS;AAAI,gBAAQ,GAAG,MAAM,UAAU,GAAG,EAAE,mBAAmB,MAAM;AAChF,aAAO,KAAK,UAAU,KAAK;AAAA,IAC7B,KAAK;AACH,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,GAAG;AAAA,IACZ,KAAK;AACH,aAAO,MAAM,OAAO,aAAa,MAAM,UAAU;AAAA,IACnD,KAAK;AACH,aAAO,MAAM,cAAc,WAAW,MAAM,iBAAgB;AAAA,EAChE;AAGA,MAAI,UAAU,KAAK;AAAG,WAAO;AAC7B,MAAI,iBAAiB;AAAQ,WAAO,OAAO,KAAK;AAChD,MAAI,iBAAiB;AAAM,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,YAAY;AACnF,MAAI,iBAAiB;AAAS,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,QAAQ;AAClF,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AACjG,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AAEjG,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AAEtE,MAAI,iBAAiB;AAAQ,WAAO,iBAAiB,OAAO,KAAK;AACjE,MAAI,iBAAiB;AAAY,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAClF,MAAI,iBAAiB;AAAa,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AACnF,MAAI,iBAAiB;AAAmB,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAGzF,SAAO,oBAAoB,KAAK;AAClC;AAGO,SAAS,WAAW,MAAwB;AACjD,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO,MAAM;AAAA,IAEf,KAAK;AAAA,IACL,KAAK;AACH,aAAO,OAAO;AAAA,IAEhB,KAAK;AAAA,IACL,KAAK;AACH,aAAO,IAAI;AAAA,IAEb;AACE,aAAO,oBAAoB;AAAA,EAC/B;AACF;AAMO,IAAM,gBAAgB,OAAO,IAAI,0CAA0C;AAE3E,SAAS,UAAU,MAAwC;AAChE,SAAO,QAAQ,KAAK,aAAa,MAAM;AACzC;AAMO,IAAM,mBAAN,cAA+B,MAAM;AAAA,EAC1C;AAAA,EAEA,YACI,SACA,UACA,SACA,MACF;AACA,UAAM,EAAE,MAAM,IAAI;AAClB,UAAM,MAAM,WAAW,SAAS;AAGhC,QAAI,WAAW,eAAe,KAAK;AACnC,QAAI,QAAQ,QAAQ;AAClB,YAAM,aAAoB,CAAC;AAE3B,aAAO,QAAQ,QAAQ;AACrB,mBAAW,KAAK,IAAI,eAAe,QAAQ,OAAO,IAAI,IAAI;AAC1D,kBAAU,QAAQ,OAAO;AAAA,MAC3B;AAEA,iBAAW,WAAW,QAAQ,EAAE,KAAK,EAAE;AAGvC,YAAM,OAAO,OAAO,QAAQ,UAAU,WAClC,oBAAoB,QAAQ,KAAe;AAAA;AAAA,QAC3C,eAAe,QAAQ,KAAK;AAAA;AAGhC,iBAAW,YAAY,eAAe,SAAS,eAAe,KAAK;AAAA,IACrE;AAEA,UAAM,YAAY,WAAW,OAAO,SAAS;AAE7C,QAAI;AAAM,WAAK,OAAO;AAAA,EACxB;AACF;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA0FO,SAAS,OAAO,OAA0B;AAC/C,MAAI,UAAU;AAAM,WAAO;AAG3B,QAAM,OAAO,OAAO;AACpB,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO;AAAA,EACX;AAGA,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO;AAEjC,MAAI,iBAAiB;AAAS,WAAO;AACrC,MAAI,OAAQ,MAAc,MAAM,MAAM;AAAY,WAAO;AAEzD,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAK,WAAO;AACjC,MAAI,iBAAiB;AAAK,WAAO;AAGjC,SAAO;AACT;AAGO,SAAS,kBACZ,SACA,MACuD;AACzD,MAAI,OAAO,QAAQ,KAAK,MAAM;AAAM;AAEpC,QAAM,IAAI,iBAAiB,SAAS,SAAS,WAAW,IAAI,KAAK,KAAK;AACxE;AAOA,SAAS,gBAAgB,OAAiC;AACxD,SAAO,OAAO,eAAe,KAAK,GAAG,aAAa;AACpD;AAGA,SAAS,iBAAiB,OAAyB,QAAwB;AACzE,QAAM,SAAS,OAAO,SAAS,KAC3B,GAAG,OAAO,SAAS,OAAO,GAAG,EAAE,mBAAmB,MAAM,WACxD,OAAO,SAAS,KAAK;AACzB,SAAO,SACH,IAAI,gBAAgB,KAAK,MAAM,YAC/B,IAAI,gBAAgB,KAAK;AAC/B;AAKO,SAAS,oBAAoB,OAAuB;AACzD,QAAM,QAAQ,OAAO,eAAe,KAAK;AACzC,MAAI,CAAE;AAAO,WAAO;AACpB,SAAO,qBAAqB,MAAM,WAAW;AAC/C;AAGO,SAAS,qBAAqB,MAA2B;AAC9D,MAAI,CAAE;AAAM,WAAO;AACnB,MAAI,CAAE,KAAK;AAAM,WAAO;AACxB,SAAO,IAAI,KAAK;AAClB;AAGO,SAAS,eAAe,OAAwB;AACrD,MAAI,UAAU;AAAM,WAAO;AAC3B,MAAI,UAAU;AAAW,WAAO;AAEhC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AACH,UAAI,MAAM,SAAS;AAAI,gBAAQ,GAAG,MAAM,UAAU,GAAG,EAAE,mBAAmB,MAAM;AAChF,aAAO,KAAK,UAAU,KAAK;AAAA,IAC7B,KAAK;AACH,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,GAAG;AAAA,IACZ,KAAK;AACH,aAAO,MAAM,OAAO,aAAa,MAAM,UAAU;AAAA,IACnD,KAAK;AACH,aAAO,MAAM,cAAc,WAAW,MAAM,iBAAgB;AAAA,EAChE;AAGA,MAAI,UAAU,KAAK;AAAG,WAAO;AAC7B,MAAI,iBAAiB;AAAQ,WAAO,OAAO,KAAK;AAChD,MAAI,iBAAiB;AAAM,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,YAAY;AACnF,MAAI,iBAAiB;AAAS,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,QAAQ;AAClF,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AACjG,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AAEjG,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AAEtE,MAAI,iBAAiB;AAAQ,WAAO,iBAAiB,OAAO,KAAK;AACjE,MAAI,iBAAiB;AAAY,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAClF,MAAI,iBAAiB;AAAa,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AACnF,MAAI,iBAAiB;AAAmB,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAGzF,SAAO,oBAAoB,KAAK;AAClC;AAGO,SAAS,WAAW,MAAwB;AACjD,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO,MAAM;AAAA,IAEf,KAAK;AAAA,IACL,KAAK;AACH,aAAO,OAAO;AAAA,IAEhB,KAAK;AAAA,IACL,KAAK;AACH,aAAO,IAAI;AAAA,IAEb;AACE,aAAO,oBAAoB;AAAA,EAC/B;AACF;AAMO,IAAM,gBAAgB,OAAO,IAAI,0CAA0C;AAE3E,SAAS,UAAU,MAA6B;AACrD,SAAO,QAAQ,KAAK,aAAa,MAAM;AACzC;AAMO,IAAM,mBAAN,cAA+B,MAAM;AAAA,EAC1C;AAAA;AAAA,EAyBA,YACI,SACA,SACA,sBACA,qBACF;AACA,UAAM,OAAO,OAAO,yBAAyB,WAAW,uBAAuB;AAC/E,UAAM,WACJ,OAAO,yBAAyB,YAAY,uBAC5C,OAAO,wBAAwB,YAAY,sBAC3C,QAAQ;AAEV,UAAM,EAAE,MAAM,IAAI;AAClB,UAAM,MAAM,WAAW,SAAS;AAGhC,QAAI,WAAW,eAAe,KAAK;AACnC,QAAI,QAAQ,QAAQ;AAClB,YAAM,aAAoB,CAAC;AAE3B,aAAO,QAAQ,QAAQ;AACrB,mBAAW,KAAK,IAAI,eAAe,QAAQ,OAAO,IAAI,IAAI;AAC1D,kBAAU,QAAQ,OAAO;AAAA,MAC3B;AAEA,iBAAW,WAAW,QAAQ,EAAE,KAAK,EAAE;AAGvC,YAAM,OAAO,OAAO,QAAQ,UAAU,WAClC,oBAAoB,QAAQ,KAAe;AAAA;AAAA,QAC3C,eAAe,QAAQ,KAAK;AAAA;AAGhC,iBAAW,YAAY,eAAe,SAAS,eAAe,KAAK;AAAA,IACrE;AAEA,UAAM,YAAY,WAAW,OAAO,SAAS;AAE7C,QAAI;AAAM,WAAK,OAAO;AAAA,EACxB;AACF;",
   "names": []
 }

package/dist/expectation/types.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { Diff } from './diff';
-import type { Expectations, ExpectationsMatcher } from './expect';
+import type { Expectations, Matchers, ExpectationFunctions } from './expect';
 /** A type identifying any constructor */
 export type Constructor<T = any> = new (...args: any[]) => T;
 /** A type identifying any function */
@@ -11,10 +11,6 @@ export type NonArrayObject<T = any> = {
     [b: symbol]: T;
     [c: number]: never;
 };
-/** A type identifying the parameter of `string.match(...)` */
-export type StringMatcher = string | RegExp | {
-    [Symbol.match](string: string): RegExpMatchArray | null;
-};
 /** Mappings for our _expanded_ {@link typeOf} implementation */
 export type TypeMappings = {
     bigint: bigint;
@@ -35,12 +31,41 @@ export type TypeMappings = {
 };
 /** Values returned by our own _expanded_ `{@link typeOf}` */
 export type TypeName = keyof TypeMappings;
+/** Join the asserted type of an {@link Expectations} with another type */
+export type JoinExpectations<E, T2> = E extends Expectations<infer T1> ? Expectations<T1 & T2> : Expectations<T2>;
+/** An assertion function, for sub-expectations and value introspection */
+export type AssertionFunction<T = unknown> = (assert: Expectations<T>) => void | Expectations;
+/** Get the type asserted by an {@link AssertionFunction} */
+export type AssertedType<F extends AssertionFunction<any>, R = ReturnType<F>> = R extends Expectations<infer T> ? T : unknown;
+/** Internal context used by expectations functions to operate */
+export interface ExpectationsContext<T = unknown> {
+    /** The value being expected */
+    readonly value: T;
+    /** Whether this is a negative or positive expectation */
+    readonly negative: boolean;
+    /** The optional parent of this instance, when constructed for a property */
+    readonly parent?: ExpectationsParent;
+    /** The current _positive_ {@link Expectations} for the value */
+    readonly expects: Expectations<T>;
+    /**
+     * If _negative_, the _negative_ {@link ExpectationFunctions} for the value,
+     * otherwise the _positive_ ones (basically, follow the `not` of `expect`).
+     */
+    readonly negated: ExpectationFunctions<T>;
+    /** Create an {@link Expectation} instance for the specified value */
+    forValue<V>(value: V): Expectations<V>;
+    /** Create an {@link Expectation} instance for a property of this value */
+    forProperty(prop: string | number | symbol): Expectations;
+}
+/** Parent expectations context (for properties) */
+export interface ExpectationsParent {
+    context: ExpectationsContext;
+    prop: string | number | symbol;
+}
 /** Expanded `typeof` implementation returning some extra types */
 export declare function typeOf(value: unknown): TypeName;
-/** Determines if the specified `value` is of the specified _expanded_ `type` */
-export declare function isType<T extends keyof TypeMappings>(context: Expectations, type: T): context is Expectations<TypeMappings[T]>;
 /** Asserts that the specified `value` is of the specified _expanded_ `type` */
-export declare function assertType<T extends keyof TypeMappings>(context: Expectations, type: T): asserts context is Expectations<TypeMappings[T]>;
+export declare function assertContextType<T extends keyof TypeMappings>(context: ExpectationsContext, type: T): asserts context is ExpectationsContext<TypeMappings[T]>;
 /** Stringify the type of an object (its constructor name) */
 export declare function stringifyObjectType(value: object): string;
 /** Stringify a constructor */
@@ -50,8 +75,25 @@ export declare function stringifyValue(value: unknown): string;
 /** Add the `a`/`an`/... prefix to the type name */
 export declare function prefixType(type: TypeName): string;
 export declare const matcherMarker: unique symbol;
-export declare function isMatcher(what: any): what is ExpectationsMatcher;
+export declare function isMatcher(what: any): what is Matchers;
 export declare class ExpectationError extends Error {
     diff?: Diff | undefined;
-    constructor(context: Expectations, negative: boolean, details: string, diff?: Diff);
+    /** Create an {@link ExpectationError} from a context and details message */
+    constructor(context: ExpectationsContext, details: string);
+    /**
+     * Create an {@link ExpectationError} from a context and details message,
+     * including an optional {@link Diff}
+     */
+    constructor(context: ExpectationsContext, details: string, diff?: Diff);
+    /**
+     * Create an {@link ExpectationError} from a context and details message,
+     * optionally forcing _negation_ to be as specified.
+     */
+    constructor(context: ExpectationsContext, details: string, forcedNegative?: boolean);
+    /**
+     * Create an {@link ExpectationError} from a context and details message,
+     * including an optional {@link Diff} and forcing _negation_ to be as
+     * specified.
+     */
+    constructor(context: ExpectationsContext, details: string, diff?: Diff, forcedNegative?: boolean);
 }

package/dist/expectation/types.mjs

@@ -29,14 +29,10 @@ function typeOf(value) {
     return "set";
   return "object";
 }
-function isType(context, type) {
-  return typeOf(context.value) === type;
-}
-function assertType(context, type) {
-  const { value } = context;
-  if (typeOf(value) === type)
+function assertContextType(context, type) {
+  if (typeOf(context.value) === type)
     return;
-  throw new ExpectationError(context, false, `to be ${prefixType(type)}`);
+  throw new ExpectationError(context, `to be ${prefixType(type)}`, false);
 }
 function constructorName(value) {
   return Object.getPrototypeOf(value)?.constructor?.name;
@@ -141,7 +137,10 @@ function isMatcher(what) {
 }
 var ExpectationError = class extends Error {
   diff;
-  constructor(context, negative, details, diff) {
+  /* Overloaded constructor implementation */
+  constructor(context, details, diffOrForcedNegative, maybeForcedNegative) {
+    const diff = typeof diffOrForcedNegative === "object" ? diffOrForcedNegative : null;
+    const negative = typeof diffOrForcedNegative === "boolean" ? diffOrForcedNegative : typeof maybeForcedNegative === "boolean" ? maybeForcedNegative : context.negative;
     const { value } = context;
     const not = negative ? " not" : "";
     let preamble = stringifyValue(value);
@@ -165,9 +164,8 @@ var ExpectationError = class extends Error {
 };
 export {
   ExpectationError,
-  assertType,
+  assertContextType,
   isMatcher,
-  isType,
   matcherMarker,
   prefixType,
   stringifyConstructor,

package/dist/expectation/types.mjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../../src/expectation/types.ts"],
-  "mappings": ";AAoDO,SAAS,OAAO,OAA0B;AAC/C,MAAI,UAAU;AAAM,WAAO;AAG3B,QAAM,OAAO,OAAO;AACpB,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO;AAAA,EACX;AAGA,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO;AAEjC,MAAI,iBAAiB;AAAS,WAAO;AACrC,MAAI,OAAQ,MAAc,MAAM,MAAM;AAAY,WAAO;AAEzD,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAK,WAAO;AACjC,MAAI,iBAAiB;AAAK,WAAO;AAGjC,SAAO;AACT;AAGO,SAAS,OACZ,SACA,MACwC;AAC1C,SAAO,OAAO,QAAQ,KAAK,MAAM;AACnC;AAGO,SAAS,WACZ,SACA,MACgD;AAClD,QAAM,EAAE,MAAM,IAAI;AAElB,MAAI,OAAO,KAAK,MAAM;AAAM;AAE5B,QAAM,IAAI,iBAAiB,SAAS,OAAO,SAAS,WAAW,IAAI,GAAG;AACxE;AAOA,SAAS,gBAAgB,OAAiC;AACxD,SAAO,OAAO,eAAe,KAAK,GAAG,aAAa;AACpD;AAGA,SAAS,iBAAiB,OAAyB,QAAwB;AACzE,QAAM,SAAS,OAAO,SAAS,KAC3B,GAAG,OAAO,SAAS,OAAO,GAAG,EAAE,mBAAmB,MAAM,WACxD,OAAO,SAAS,KAAK;AACzB,SAAO,SACH,IAAI,gBAAgB,KAAK,MAAM,YAC/B,IAAI,gBAAgB,KAAK;AAC/B;AAKO,SAAS,oBAAoB,OAAuB;AACzD,QAAM,QAAQ,OAAO,eAAe,KAAK;AACzC,MAAI,CAAE;AAAO,WAAO;AACpB,SAAO,qBAAqB,MAAM,WAAW;AAC/C;AAGO,SAAS,qBAAqB,MAA2B;AAC9D,MAAI,CAAE;AAAM,WAAO;AACnB,MAAI,CAAE,KAAK;AAAM,WAAO;AACxB,SAAO,IAAI,KAAK;AAClB;AAGO,SAAS,eAAe,OAAwB;AACrD,MAAI,UAAU;AAAM,WAAO;AAC3B,MAAI,UAAU;AAAW,WAAO;AAEhC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AACH,UAAI,MAAM,SAAS;AAAI,gBAAQ,GAAG,MAAM,UAAU,GAAG,EAAE,mBAAmB,MAAM;AAChF,aAAO,KAAK,UAAU,KAAK;AAAA,IAC7B,KAAK;AACH,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,GAAG;AAAA,IACZ,KAAK;AACH,aAAO,MAAM,OAAO,aAAa,MAAM,UAAU;AAAA,IACnD,KAAK;AACH,aAAO,MAAM,cAAc,WAAW,MAAM,iBAAgB;AAAA,EAChE;AAGA,MAAI,UAAU,KAAK;AAAG,WAAO;AAC7B,MAAI,iBAAiB;AAAQ,WAAO,OAAO,KAAK;AAChD,MAAI,iBAAiB;AAAM,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,YAAY;AACnF,MAAI,iBAAiB;AAAS,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,QAAQ;AAClF,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AACjG,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AAEjG,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AAEtE,MAAI,iBAAiB;AAAQ,WAAO,iBAAiB,OAAO,KAAK;AACjE,MAAI,iBAAiB;AAAY,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAClF,MAAI,iBAAiB;AAAa,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AACnF,MAAI,iBAAiB;AAAmB,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAGzF,SAAO,oBAAoB,KAAK;AAClC;AAGO,SAAS,WAAW,MAAwB;AACjD,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO,MAAM;AAAA,IAEf,KAAK;AAAA,IACL,KAAK;AACH,aAAO,OAAO;AAAA,IAEhB,KAAK;AAAA,IACL,KAAK;AACH,aAAO,IAAI;AAAA,IAEb;AACE,aAAO,oBAAoB;AAAA,EAC/B;AACF;AAMO,IAAM,gBAAgB,OAAO,IAAI,0CAA0C;AAE3E,SAAS,UAAU,MAAwC;AAChE,SAAO,QAAQ,KAAK,aAAa,MAAM;AACzC;AAMO,IAAM,mBAAN,cAA+B,MAAM;AAAA,EAC1C;AAAA,EAEA,YACI,SACA,UACA,SACA,MACF;AACA,UAAM,EAAE,MAAM,IAAI;AAClB,UAAM,MAAM,WAAW,SAAS;AAGhC,QAAI,WAAW,eAAe,KAAK;AACnC,QAAI,QAAQ,QAAQ;AAClB,YAAM,aAAoB,CAAC;AAE3B,aAAO,QAAQ,QAAQ;AACrB,mBAAW,KAAK,IAAI,eAAe,QAAQ,OAAO,IAAI,IAAI;AAC1D,kBAAU,QAAQ,OAAO;AAAA,MAC3B;AAEA,iBAAW,WAAW,QAAQ,EAAE,KAAK,EAAE;AAGvC,YAAM,OAAO,OAAO,QAAQ,UAAU,WAClC,oBAAoB,QAAQ,KAAe;AAAA;AAAA,QAC3C,eAAe,QAAQ,KAAK;AAAA;AAGhC,iBAAW,YAAY,eAAe,SAAS,eAAe,KAAK;AAAA,IACrE;AAEA,UAAM,YAAY,WAAW,OAAO,SAAS;AAE7C,QAAI;AAAM,WAAK,OAAO;AAAA,EACxB;AACF;",
+  "mappings": ";AA0FO,SAAS,OAAO,OAA0B;AAC/C,MAAI,UAAU;AAAM,WAAO;AAG3B,QAAM,OAAO,OAAO;AACpB,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO;AAAA,EACX;AAGA,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO;AAEjC,MAAI,iBAAiB;AAAS,WAAO;AACrC,MAAI,OAAQ,MAAc,MAAM,MAAM;AAAY,WAAO;AAEzD,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAQ,WAAO;AACpC,MAAI,iBAAiB;AAAK,WAAO;AACjC,MAAI,iBAAiB;AAAK,WAAO;AAGjC,SAAO;AACT;AAGO,SAAS,kBACZ,SACA,MACuD;AACzD,MAAI,OAAO,QAAQ,KAAK,MAAM;AAAM;AAEpC,QAAM,IAAI,iBAAiB,SAAS,SAAS,WAAW,IAAI,KAAK,KAAK;AACxE;AAOA,SAAS,gBAAgB,OAAiC;AACxD,SAAO,OAAO,eAAe,KAAK,GAAG,aAAa;AACpD;AAGA,SAAS,iBAAiB,OAAyB,QAAwB;AACzE,QAAM,SAAS,OAAO,SAAS,KAC3B,GAAG,OAAO,SAAS,OAAO,GAAG,EAAE,mBAAmB,MAAM,WACxD,OAAO,SAAS,KAAK;AACzB,SAAO,SACH,IAAI,gBAAgB,KAAK,MAAM,YAC/B,IAAI,gBAAgB,KAAK;AAC/B;AAKO,SAAS,oBAAoB,OAAuB;AACzD,QAAM,QAAQ,OAAO,eAAe,KAAK;AACzC,MAAI,CAAE;AAAO,WAAO;AACpB,SAAO,qBAAqB,MAAM,WAAW;AAC/C;AAGO,SAAS,qBAAqB,MAA2B;AAC9D,MAAI,CAAE;AAAM,WAAO;AACnB,MAAI,CAAE,KAAK;AAAM,WAAO;AACxB,SAAO,IAAI,KAAK;AAClB;AAGO,SAAS,eAAe,OAAwB;AACrD,MAAI,UAAU;AAAM,WAAO;AAC3B,MAAI,UAAU;AAAW,WAAO;AAEhC,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AACH,UAAI,MAAM,SAAS;AAAI,gBAAQ,GAAG,MAAM,UAAU,GAAG,EAAE,mBAAmB,MAAM;AAChF,aAAO,KAAK,UAAU,KAAK;AAAA,IAC7B,KAAK;AACH,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,UAAI,UAAU,OAAO;AAAmB,eAAO;AAC/C,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,OAAO,KAAK;AAAA,IACrB,KAAK;AACH,aAAO,GAAG;AAAA,IACZ,KAAK;AACH,aAAO,MAAM,OAAO,aAAa,MAAM,UAAU;AAAA,IACnD,KAAK;AACH,aAAO,MAAM,cAAc,WAAW,MAAM,iBAAgB;AAAA,EAChE;AAGA,MAAI,UAAU,KAAK;AAAG,WAAO;AAC7B,MAAI,iBAAiB;AAAQ,WAAO,OAAO,KAAK;AAChD,MAAI,iBAAiB;AAAM,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,YAAY;AACnF,MAAI,iBAAiB;AAAS,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM,QAAQ;AAClF,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AACjG,MAAI,iBAAiB;AAAQ,WAAO,IAAI,gBAAgB,KAAK,MAAM,eAAe,MAAM,QAAQ,CAAC;AAEjG,MAAI,MAAM,QAAQ,KAAK;AAAG,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AACtE,MAAI,iBAAiB;AAAK,WAAO,IAAI,gBAAgB,KAAK,MAAM,MAAM;AAEtE,MAAI,iBAAiB;AAAQ,WAAO,iBAAiB,OAAO,KAAK;AACjE,MAAI,iBAAiB;AAAY,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAClF,MAAI,iBAAiB;AAAa,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AACnF,MAAI,iBAAiB;AAAmB,WAAO,iBAAiB,OAAO,OAAO,KAAK,KAAK,CAAC;AAGzF,SAAO,oBAAoB,KAAK;AAClC;AAGO,SAAS,WAAW,MAAwB;AACjD,UAAQ,MAAM;AAAA,IACZ,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO,MAAM;AAAA,IAEf,KAAK;AAAA,IACL,KAAK;AACH,aAAO,OAAO;AAAA,IAEhB,KAAK;AAAA,IACL,KAAK;AACH,aAAO,IAAI;AAAA,IAEb;AACE,aAAO,oBAAoB;AAAA,EAC/B;AACF;AAMO,IAAM,gBAAgB,OAAO,IAAI,0CAA0C;AAE3E,SAAS,UAAU,MAA6B;AACrD,SAAO,QAAQ,KAAK,aAAa,MAAM;AACzC;AAMO,IAAM,mBAAN,cAA+B,MAAM;AAAA,EAC1C;AAAA;AAAA,EAyBA,YACI,SACA,SACA,sBACA,qBACF;AACA,UAAM,OAAO,OAAO,yBAAyB,WAAW,uBAAuB;AAC/E,UAAM,WACJ,OAAO,yBAAyB,YAAY,uBAC5C,OAAO,wBAAwB,YAAY,sBAC3C,QAAQ;AAEV,UAAM,EAAE,MAAM,IAAI;AAClB,UAAM,MAAM,WAAW,SAAS;AAGhC,QAAI,WAAW,eAAe,KAAK;AACnC,QAAI,QAAQ,QAAQ;AAClB,YAAM,aAAoB,CAAC;AAE3B,aAAO,QAAQ,QAAQ;AACrB,mBAAW,KAAK,IAAI,eAAe,QAAQ,OAAO,IAAI,IAAI;AAC1D,kBAAU,QAAQ,OAAO;AAAA,MAC3B;AAEA,iBAAW,WAAW,QAAQ,EAAE,KAAK,EAAE;AAGvC,YAAM,OAAO,OAAO,QAAQ,UAAU,WAClC,oBAAoB,QAAQ,KAAe;AAAA;AAAA,QAC3C,eAAe,QAAQ,KAAK;AAAA;AAGhC,iBAAW,YAAY,eAAe,SAAS,eAAe,KAAK;AAAA,IACrE;AAEA,UAAM,YAAY,WAAW,OAAO,SAAS;AAE7C,QAAI;AAAM,WAAK,OAAO;AAAA,EACxB;AACF;",
   "names": []
 }

package/dist/index.cjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA+B;AAC/B,mBAA+B;AAQ/B,mBAKO;AACP,wBAAqB;AACrB,oBAAuB;AAAA,IAqCvB,4BAAe,YAAQ,6BAAe,YAAW,QAAQ,GAAG,MAAM;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA+B;AAC/B,mBAA+B;AAQ/B,mBAKO;AACP,wBAAqB;AACrB,oBAAuB;AAAA,IAuCvB,4BAAe,YAAQ,6BAAe,YAAW,QAAQ,GAAG,MAAM;",
   "names": []
 }

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import type { ForkOptions } from '@plugjs/plug/fork';
 export { it, fit, xit, describe, fdescribe, xdescribe, afterAll, afterEach, xafterAll, xafterEach, beforeAll, beforeEach, xbeforeAll, xbeforeEach, } from './execution/setup';
 export { skip } from './execution/executable';
 export { expect } from './expectation/expect';
+export type { Expectations } from './expectation/expect';
 /** Options to construct our {@link Jasmine} plug. */
 export interface TestOptions extends ForkOptions {
     /** Report up to the specified amount of failures (default: `+Infinity`) */

package/dist/index.mjs.map

@@ -1,6 +1,6 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "mappings": ";AAAA,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAQ/B;AAAA,EACE;AAAA,EAAI;AAAA,EAAK;AAAA,EACT;AAAA,EAAU;AAAA,EAAW;AAAA,EACrB;AAAA,EAAU;AAAA,EAAW;AAAA,EAAW;AAAA,EAChC;AAAA,EAAW;AAAA,EAAY;AAAA,EAAY;AAAA,OAC9B;AACP,SAAS,YAAY;AACrB,SAAS,cAAc;AAqCvB,eAAe,QAAQ,eAAe,iBAAW,QAAQ,GAAG,MAAM;",
+  "mappings": ";AAAA,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAQ/B;AAAA,EACE;AAAA,EAAI;AAAA,EAAK;AAAA,EACT;AAAA,EAAU;AAAA,EAAW;AAAA,EACrB;AAAA,EAAU;AAAA,EAAW;AAAA,EAAW;AAAA,EAChC;AAAA,EAAW;AAAA,EAAY;AAAA,EAAY;AAAA,OAC9B;AACP,SAAS,YAAY;AACrB,SAAS,cAAc;AAuCvB,eAAe,QAAQ,eAAe,iBAAW,QAAQ,GAAG,MAAM;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plugjs/expect5",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -47,7 +47,7 @@
     "chai": "^4.3.7"
   },
   "peerDependencies": {
-    "@plugjs/plug": "0.4.2"
+    "@plugjs/plug": "0.4.3"
   },
   "files": [
     "*.md",

package/src/expectation/async.ts

@@ -0,0 +1,151 @@
+import { ExpectationError } from './types'
+
+import type { Expectations } from './expect'
+import type {
+  AssertedType,
+  AssertionFunction,
+  Constructor,
+  ExpectationsContext,
+} from './types'
+
+/**
+ * A {@link Promise} for an {@link Expectations} instance expecting a
+ * _then-able_ {@link PromiseLike}.
+ *
+ * Long story short: the {@link toBeResolved}, {@link toBeRejectedWithError} and
+ * {@link toBeRejected} expectations are asynchronous, henceforth they return
+ * the first {@link Promise} to an {@link Expectations} instance. They also
+ * ensure that the value being expected is a _then-able_ {@link PromiseLike}.
+ */
+type ExpectationsPromise<E, T2 = unknown> =
+  unknown extends T2 ?
+    E extends Expectations<infer T1> ?
+      Promise<Expectations<PromiseLike<Awaited<T1>>>> :
+      Promise<Expectations<PromiseLike<unknown>>> :
+      Promise<Expectations<PromiseLike<T2>>>
+
+/* === TO BE RESOLVED ======================================================= */
+
+/** Expects the value to be a _resolved_ {@link PromiseLike}. */
+function toBeResolved<T>(this: T): ExpectationsPromise<T>
+
+/**
+ * Expects the value to be a _resolved_ {@link Promise}, and asserts the
+ * resolved result with the specified callback.
+ */
+function toBeResolved<T, A extends AssertionFunction>(
+  this: T,
+  assert: A,
+): ExpectationsPromise<T, AssertedType<A>>
+
+/* Overloaded function implementation */
+function toBeResolved(
+    this: ExpectationsContext,
+    assert?: (resultExpectations: Expectations) => void,
+): Promise<Expectations> {
+  void assert
+  return Promise.resolve()
+      .then(() => {
+        this.expects.toHaveProperty('then', (a) => a.toBeA('function'))
+        return Promise.allSettled([ Promise.resolve(this.value) ])
+      })
+      .then(([ settlement ]) => {
+        if (settlement.status === 'fulfilled') {
+          if (this.negative) throw new ExpectationError(this, 'to be resolved')
+          if (assert) assert(this.forValue(settlement.value))
+        } else if (! this.negative) {
+          throw new ExpectationError(this, 'to be resolved')
+        }
+
+        return this.expects
+      })
+}
+
+/* === TO BE REJECTED ======================================================= */
+
+/** Expect the value to be a _rejected_ {@link Promise}. */
+function toBeRejected<T>(this: T): ExpectationsPromise<T>
+
+/**
+ * Expect the value to be a _rejected_ {@link Promise}, and asserts the
+ * rejection reason with the specified callback.
+ */
+function toBeRejected<T>(this: T, assert: AssertionFunction): ExpectationsPromise<T>
+
+/* Overloaded function implementation */
+function toBeRejected(
+    this: ExpectationsContext,
+    assert?: AssertionFunction,
+): Promise<Expectations> {
+  return Promise.resolve()
+      .then(() => {
+        this.expects.toHaveProperty('then', (a) => a.toBeA('function'))
+        return Promise.allSettled([ Promise.resolve(this.value) ])
+      })
+      .then(([ settlement ]) => {
+        if (settlement.status === 'rejected') {
+          if (this.negative) throw new ExpectationError(this, 'to be rejected')
+          if (assert) assert(this.forValue(settlement.reason))
+        } else if (! this.negative) {
+          throw new ExpectationError(this, 'to be rejected')
+        }
+
+        return this.expects
+      })
+}
+
+/* === TO BE REJECTED WITH ERROR ============================================ */
+
+/** Expect the value to be a {@link Promise} _rejected_ by an {@link Error}. */
+function toBeRejectedWithError<T>(this: T, ): ExpectationsPromise<T>
+
+/**
+ * Expect the value to be a {@link Promise} _rejected_ by an {@link Error}
+ * with the specified _message_.
+ */
+function toBeRejectedWithError<T>(this: T, message: string): ExpectationsPromise<T>
+
+/**
+ * Expect the value to be a {@link Promise} _rejected_ by an {@link Error}
+ * with its _message_ matching the specified {@link RegExp}.
+ */
+function toBeRejectedWithError<T>(this: T, message: RegExp): ExpectationsPromise<T>
+
+/**
+ * Expect the value to be a {@link Promise} _rejected_ by an {@link Error}
+ * of the specified _type_.
+ */
+function toBeRejectedWithError<T>(this: T, constructor: Constructor<Error>): ExpectationsPromise<T>
+
+/**
+ * Expect the value to be a {@link Promise} _rejected_ by an {@link Error}
+ * of the specified _type_ and with the specified _message_.
+ */
+function toBeRejectedWithError<T>(this: T, constructor: Constructor<Error>, message: string): ExpectationsPromise<T>
+
+/**
+ * Expect the value to be a {@link Promise} _rejected_ by an {@link Error}
+ * of the specified _type_ and with the specified _message_.
+ */
+function toBeRejectedWithError<T>(this: T, constructor: Constructor<Error>, message: RegExp): ExpectationsPromise<T>
+
+/* Overloaded function implementation */
+function toBeRejectedWithError(
+    this: ExpectationsContext,
+    ...args:
+    | []
+    | [ string ]
+    | [ RegExp ]
+    | [ Constructor<Error> ]
+    | [ Constructor<Error>, string ]
+    | [ Constructor<Error>, RegExp ]
+): Promise<Expectations> {
+  return this.negated.toBeRejected((assert) =>
+    // @ts-ignore // can't reconcile the types with overloads...
+    assert.toBeError(...args))
+}
+
+/* === EXPORTS ============================================================== */
+
+/* coverage ignore next */
+export { toBeResolved, toBeRejected, toBeRejectedWithError }