Type fixes (#774)

* doc: Remove @example JS Doc
because it's not part of our JS Doc pattern

* fix: Fix some types bugs

* ci: Add changeset

Author: keeganwitt

.changeset/funny-weeks-see.md

@@ -0,0 +1,5 @@
+---
+'jest-extended': patch
+---
+
+Fix some types bugs

src/matchers/toChange.ts

@@ -1,7 +1,5 @@
 /**
  * Use `.toChange` when checking if a value has changed.
- * @example
- * expect(() => value--).toChange(() => value);
  */
 export function toChange(mutator: () => unknown | void, checker: () => number) {
   // @ts-expect-error OK to have implicit any for this.utils

src/matchers/toChangeBy.ts

@@ -1,7 +1,5 @@
 /**
  * Use `.toChangeBy` when checking if a value changed by an amount.
- * @example
- * expect(() => value--).toChangeBy(() => value, -1);
  */
 export function toChangeBy(mutator: () => unknown | void, checker: () => number, by: number = 1) {
   // @ts-expect-error OK to have implicit any for this.utils

src/matchers/toChangeTo.ts

@@ -1,7 +1,5 @@
 /**
  * Use `.toChangeTo` when checking if a value changed to a specific value.
- * @example
- * expect(() => Model.deleteAll()).toChangeTo(() => Model.count(), 0);
  */
 export function toChangeTo(mutator: () => unknown | void, checker: () => number, to: number) {
   // @ts-expect-error OK to have implicit any for this.utils

types/index.d.ts

@@ -64,13 +64,25 @@ interface CustomMatchers<R> extends Record<string, any> {
    * Use `.toIncludeAllMembers` when checking if an `Array` contains all of the same members of a given set.
    * @param {Array.<*>} members
    */
-  toIncludeAllMembers<E = unknown>(members: readonly E[]): R;
+  toIncludeAllMembers<E = unknown>(members: readonly E[] | E): R;
+
+  /**
+   * Use `.toIncludeAllPartialMembers` when checking if an `Array` contains all the same partial members of a given set.
+   * @param {Array.<*>} members
+   */
+  toIncludeAllPartialMembers<E = unknown>(members: readonly E[] | E): R;
+
+  /**
+   * Use `.toIncludeSamePartialMembers` when checking if an `Array` contains exactly the same partial members as a given set, in any order
+   * @param {Array.<*>} members
+   */
+  toIncludeSamePartialMembers<E = unknown>(members: readonly E[]): R;
 
   /**
    * Use `.toIncludeAnyMembers` when checking if an `Array` contains any of the members of a given set.
    * @param {Array.<*>} members
    */
-  toIncludeAnyMembers<E = unknown>(members: readonly E[]): R;
+  toIncludeAnyMembers<E = unknown>(members: readonly E[] | E): R;
 
   /**
    * Use `.toIncludeSameMembers` when checking if two arrays contain equal values, in any order.
@@ -222,6 +234,26 @@ interface CustomMatchers<R> extends Record<string, any> {
    */
   toBeObject(): R;
 
+  /**
+   * Use `.toChange` when checking if a value has changed.
+   * @param {Function} checker
+   */
+  toChange<E = unknown>(checker: () => E): R;
+
+  /**
+   * Use `.toChangeBy` when checking if a value changed by an amount.
+   * @param {Function} checker
+   * @param {Number} by
+   */
+  toChangeBy(checker: () => number, by?: number): R;
+
+  /**
+   * Use `.toChangeTo` when checking if a value changed to a specific value.
+   * @param {Function} checker
+   * @param {*} to
+   */
+  toChangeTo<E = unknown>(checker: () => E, to: E): R;
+
   /**
    * Use `.toContainKey` when checking if an object contains the provided key.
    *
@@ -385,7 +417,10 @@ interface CustomMatchers<R> extends Record<string, any> {
    * @param {Function} type
    * @param {String | RegExp} message
    */
-  toThrowWithMessage(type: (...args: any[]) => any, message: string | RegExp): R;
+  toThrowWithMessage(
+    type: (new (...args: any[]) => { message: string }) | ((...args: any[]) => { message: string }),
+    message: string | RegExp,
+  ): R;
 
   /**
    * Use `.toBeEmptyObject` when checking if a value is an empty `Object`.
@@ -669,24 +704,23 @@ declare namespace jest {
 
     /**
      * Use `.toChange` when checking if a value has changed.
-     * @example
-     * expect(() => value--).toChange(() => value);
+     * @param {Function} checker
      */
     toChange<E = unknown>(checker: () => E): R;
 
     /**
-     * Use `.toChangeTo` when checking if a value changed to a specific value.
-     * @example
-     * expect(() => Model.deleteAll()).toChangeTo(() => Model.count(), 0);
+     * Use `.toChangeBy` when checking if a value changed by an amount.
+     * @param {Function} checker
+     * @param {Number} by
      */
-    toChangeTo<E = unknown>(checker: () => E, to: E): R;
+    toChangeBy(checker: () => number, by?: number): R;
 
     /**
-     * Use `.toChangeBy` when checking if a value changed by an amount.
-     * @example
-     * expect(() => value--).toChangeBy(() => value, -1);
+     * Use `.toChangeTo` when checking if a value changed to a specific value.
+     * @param {Function} checker
+     * @param {*} to
      */
-    toChangeBy(checker: () => number, by?: number): R;
+    toChangeTo<E = unknown>(checker: () => E, to: E): R;
 
     /**
      * Use `.toContainKey` when checking if an object contains the provided key.
@@ -852,10 +886,7 @@ declare namespace jest {
      * @param {String | RegExp} message
      */
     toThrowWithMessage(
-      type:
-        | (new (...args: any[]) => { message: string })
-        | (abstract new (...args: any[]) => { message: string })
-        | ((...args: any[]) => { message: string }),
+      type: (new (...args: any[]) => { message: string }) | ((...args: any[]) => { message: string }),
       message: string | RegExp,
     ): R;