feat(typings): improve type information

All functions are now type guards with an optional generic which can be provided if you want to override or otherwise be more specific about what type your asserted value is. BREAKING CHANGE The return types have changed from eg. `boolean` to `value is number[]`, which may result in type errors in your projects.
JamieMason · Aug 8, 2021 · 4cff05e · 4cff05e
1 parent 2cbe184
commit 4cff05e
Show file tree

Hide file tree

Showing 203 changed files with 683 additions and 502 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 node_modules
+packages/*/dist
 packages/*/node_modules
diff --git a/packages/expect-more-jasmine/src/to-be-after.ts b/packages/expect-more-jasmine/src/to-be-after.ts
@@ -3,6 +3,7 @@ import { printExpected, printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a valid instance of `Date` whose value occurs after that of ${otherDate}.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeAfterMatcher = () => {
+export const toBeAfterMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any, otherDate: Date) {
+    compare(value: unknown, otherDate: Date) {
       const pass = isAfter(otherDate, value);
       const message = pass
         ? `expected ${printReceived(

diff --git a/packages/expect-more-jasmine/src/to-be-array-of-booleans.ts b/packages/expect-more-jasmine/src/to-be-array-of-booleans.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is an `Array` containing only `Boolean` values.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeArrayOfBooleansMatcher = () => {
+export const toBeArrayOfBooleansMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isArrayOfBooleans(value);
       const message = pass
         ? `expected ${printReceived(

diff --git a/packages/expect-more-jasmine/src/to-be-array-of-numbers.ts b/packages/expect-more-jasmine/src/to-be-array-of-numbers.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is an `Array` containing only `Number` values.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeArrayOfNumbersMatcher = () => {
+export const toBeArrayOfNumbersMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isArrayOfNumbers(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be a non-empty array, containing only numbers`

diff --git a/packages/expect-more-jasmine/src/to-be-array-of-objects.ts b/packages/expect-more-jasmine/src/to-be-array-of-objects.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is an `Array` containing only `Object` values.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeArrayOfObjectsMatcher = () => {
+export const toBeArrayOfObjectsMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isArrayOfObjects(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be a non-empty array, containing only objects`

diff --git a/packages/expect-more-jasmine/src/to-be-array-of-size.ts b/packages/expect-more-jasmine/src/to-be-array-of-size.ts
@@ -3,6 +3,7 @@ import { printExpected, printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is an `Array` containing ${size} number of values.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeArrayOfSizeMatcher = () => {
+export const toBeArrayOfSizeMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any, size: number) {
+    compare(value: unknown, size: number) {
       const pass = isArrayOfSize(size, value);
       const message = pass
         ? `expected ${printReceived(value)} not to be an array containing exactly ${printExpected(

diff --git a/packages/expect-more-jasmine/src/to-be-array-of-strings.ts b/packages/expect-more-jasmine/src/to-be-array-of-strings.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is an `Array` containing only `String` values.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeArrayOfStringsMatcher = () => {
+export const toBeArrayOfStringsMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isArrayOfStrings(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be a non-empty array, containing only strings`

diff --git a/packages/expect-more-jasmine/src/to-be-array.ts b/packages/expect-more-jasmine/src/to-be-array.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a valid `Array` containing none or any number of items of any type.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeArrayMatcher = () => {
+export const toBeArrayMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isArray(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be an array`

diff --git a/packages/expect-more-jasmine/src/to-be-async-function.ts b/packages/expect-more-jasmine/src/to-be-async-function.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a function using async/await syntax.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeAsyncFunctionMatcher = () => {
+export const toBeAsyncFunctionMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isAsyncFunction(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be a function using async/await syntax`

diff --git a/packages/expect-more-jasmine/src/to-be-before.ts b/packages/expect-more-jasmine/src/to-be-before.ts
@@ -3,6 +3,7 @@ import { printExpected, printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a valid instance of `Date` whose value occurs before that of ${otherDate}.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeBeforeMatcher = () => {
+export const toBeBeforeMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any, otherDate: Date) {
+    compare(value: unknown, otherDate: Date) {
       const pass = isBefore(otherDate, value);
       const message = pass
         ? `expected ${printReceived(

diff --git a/packages/expect-more-jasmine/src/to-be-boolean.ts b/packages/expect-more-jasmine/src/to-be-boolean.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is `true`, `false`, `new Boolean(true)`, or `new Boolean(false)`.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeBooleanMatcher = () => {
+export const toBeBooleanMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isBoolean(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be true, false, or an instance of Boolean`

diff --git a/packages/expect-more-jasmine/src/to-be-calculable.ts b/packages/expect-more-jasmine/src/to-be-calculable.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Assert value can be used in Mathemetic calculations despite not being a `Number`, for example `'1' * '2' === 2` whereas `'wut?' * 2 === NaN`.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeCalculableMatcher = () => {
+export const toBeCalculableMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isCalculable(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be coercible for use in mathemetical operations`

diff --git a/packages/expect-more-jasmine/src/to-be-date.ts b/packages/expect-more-jasmine/src/to-be-date.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is an instance of `Date`.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeDateMatcher = () => {
+export const toBeDateMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isDate(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be an instance of Date`

diff --git a/packages/expect-more-jasmine/src/to-be-decimal-number.ts b/packages/expect-more-jasmine/src/to-be-decimal-number.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a `Number` with positive decimal places.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeDecimalNumberMatcher = () => {
+export const toBeDecimalNumberMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isDecimalNumber(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be a number with positive decimal places`

diff --git a/packages/expect-more-jasmine/src/to-be-divisible-by.ts b/packages/expect-more-jasmine/src/to-be-divisible-by.ts
@@ -3,6 +3,7 @@ import { printExpected, printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a `Number` which results in a whole number when divided by ${otherNumber}.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeDivisibleByMatcher = () => {
+export const toBeDivisibleByMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any, otherNumber: number) {
+    compare(value: unknown, otherNumber: number) {
       const pass = isDivisibleBy(otherNumber, value);
       const message = pass
         ? `expected ${printReceived(value)} not to be divisible by ${printExpected(otherNumber)}`

diff --git a/packages/expect-more-jasmine/src/to-be-empty-array.ts b/packages/expect-more-jasmine/src/to-be-empty-array.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a valid `Array` containing no items.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeEmptyArrayMatcher = () => {
+export const toBeEmptyArrayMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isEmptyArray(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be an array containing no items`

diff --git a/packages/expect-more-jasmine/src/to-be-empty-object.ts b/packages/expect-more-jasmine/src/to-be-empty-object.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a valid `Object` containing no instance members.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeEmptyObjectMatcher = () => {
+export const toBeEmptyObjectMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isEmptyObject(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be an empty object`

diff --git a/packages/expect-more-jasmine/src/to-be-empty-string.ts b/packages/expect-more-jasmine/src/to-be-empty-string.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a valid `String` containing no characters.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeEmptyStringMatcher = () => {
+export const toBeEmptyStringMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isEmptyString(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be an empty string or empty instance of String`

diff --git a/packages/expect-more-jasmine/src/to-be-even-number.ts b/packages/expect-more-jasmine/src/to-be-even-number.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is an even `Number`.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeEvenNumberMatcher = () => {
+export const toBeEvenNumberMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isEvenNumber(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be an even number`

diff --git a/packages/expect-more-jasmine/src/to-be-function.ts b/packages/expect-more-jasmine/src/to-be-function.ts
@@ -3,6 +3,7 @@ import { printReceived } from 'jest-matcher-utils';
 
 declare global {
   namespace jasmine {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<T> {
       /**
        * Asserts that ${value} is a `Function`.
@@ -14,9 +15,9 @@ declare global {
   }
 }
 
-export const toBeFunctionMatcher = () => {
+export const toBeFunctionMatcher: jasmine.CustomMatcherFactory = () => {
   return {
-    compare(value: any) {
+    compare(value: unknown) {
       const pass = isFunction(value);
       const message = pass
         ? `expected ${printReceived(value)} not to be a function or async function`