-
-
Save trentm/be37b10e8e38e1452f64f76761d9c5b5 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--- node_modules/@types/chai/index.d.ts 2024-08-14 12:48:05 | |
+++ /Users/trentm/tm/opentelemetry-js-contrib11/node_modules/@types/chai/index.d.ts 2024-08-14 13:00:46 | |
@@ -9,6 +9,10 @@ | |
exists: boolean; | |
} | |
+ interface Constructor<T> { | |
+ new(...args: any[]): T; | |
+ } | |
+ | |
interface ErrorConstructor { | |
new(...args: any[]): Error; | |
} | |
@@ -417,20 +421,18 @@ | |
/** | |
* Asserts that object is truthy. | |
* | |
- * T Type of object. | |
* @param object Object to test. | |
* @param message Message to display on error. | |
*/ | |
- isOk<T>(value: T, message?: string): void; | |
+ isOk(value: unknown, message?: string): asserts value; | |
/** | |
* Asserts that object is truthy. | |
* | |
- * T Type of object. | |
* @param object Object to test. | |
* @param message Message to display on error. | |
*/ | |
- ok<T>(value: T, message?: string): void; | |
+ ok(value: unknown, message?: string): asserts value; | |
/** | |
* Asserts that object is falsy. | |
@@ -559,20 +561,18 @@ | |
/** | |
* Asserts that value is true. | |
* | |
- * T Type of value. | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isTrue<T>(value: T, message?: string): void; | |
+ isTrue(value: unknown, message?: string): asserts value is true; | |
/** | |
* Asserts that value is false. | |
* | |
- * T Type of value. | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isFalse<T>(value: T, message?: string): void; | |
+ isFalse(value: unknown, message?: string): asserts value is false; | |
/** | |
* Asserts that value is not true. | |
@@ -581,25 +581,23 @@ | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isNotTrue<T>(value: T, message?: string): void; | |
+ isNotTrue<T>(value: T, message?: string): asserts value is Exclude<T, true>; | |
/** | |
* Asserts that value is not false. | |
* | |
- * T Type of value. | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isNotFalse<T>(value: T, message?: string): void; | |
+ isNotFalse<T>(value: T, message?: string): asserts value is Exclude<T, false>; | |
/** | |
* Asserts that value is null. | |
* | |
- * T Type of value. | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isNull<T>(value: T, message?: string): void; | |
+ isNull(value: unknown, message?: string): asserts value is null; | |
/** | |
* Asserts that value is not null. | |
@@ -608,7 +606,7 @@ | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isNotNull<T>(value: T, message?: string): void; | |
+ isNotNull<T>(value: T, message?: string): asserts value is Exclude<T, null>; | |
/** | |
* Asserts that value is NaN. | |
@@ -635,25 +633,25 @@ | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- exists<T>(value: T, message?: string): void; | |
+ exists<T>(value: T, message?: string): asserts value is NonNullable<T>; | |
/** | |
* Asserts that the target is either null or undefined. | |
* | |
- * T Type of value. | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- notExists<T>(value: T, message?: string): void; | |
+ notExists(value: unknown, message?: string): asserts value is | |
+ | null | |
+ | undefined; | |
/** | |
* Asserts that value is undefined. | |
* | |
- * T Type of value. | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isUndefined<T>(value: T, message?: string): void; | |
+ isUndefined(value: unknown, message?: string): asserts value is undefined; | |
/** | |
* Asserts that value is not undefined. | |
@@ -662,7 +660,7 @@ | |
* @param value Actual value. | |
* @param message Message to display on error. | |
*/ | |
- isDefined<T>(value: T, message?: string): void; | |
+ isDefined<T>(value: T, message?: string): asserts value is Exclude<T, undefined>; | |
/** | |
* Asserts that value is a function. | |
@@ -808,22 +806,27 @@ | |
/** | |
* Asserts that value is an instance of constructor. | |
* | |
- * T Type of value. | |
+ * T Expected type of value. | |
* @param value Actual value. | |
* @param constructor Potential expected contructor of value. | |
* @param message Message to display on error. | |
*/ | |
- instanceOf<T>(value: T, constructor: Function, message?: string): void; | |
+ instanceOf<T>( | |
+ value: unknown, | |
+ constructor: Constructor<T>, | |
+ message?: string, | |
+ ): asserts value is T; | |
/** | |
* Asserts that value is not an instance of constructor. | |
* | |
* T Type of value. | |
+ * U Type that value shouldn't be an instance of. | |
* @param value Actual value. | |
* @param constructor Potential expected contructor of value. | |
* @param message Message to display on error. | |
*/ | |
- notInstanceOf<T>(value: T, type: Function, message?: string): void; | |
+ notInstanceOf<T, U>(value: T, type: Constructor<U>, message?: string): asserts value is Exclude<T, U>; | |
/** | |
* Asserts that haystack includes needle. | |
@@ -869,7 +872,7 @@ | |
include<T>(haystack: T, needle: Partial<T>, message?: string): void; | |
/** | |
- * Asserts that haystack does not includes needle. | |
+ * Asserts that haystack does not include needle. | |
* | |
* @param haystack Container string. | |
* @param needle Potential substring of haystack. | |
@@ -878,7 +881,7 @@ | |
notInclude(haystack: string, needle: string, message?: string): void; | |
/** | |
- * Asserts that haystack does not includes needle. | |
+ * Asserts that haystack does not include needle. | |
* | |
* T Type of values in haystack. | |
* @param haystack Container array, set or map. | |
@@ -892,7 +895,7 @@ | |
): void; | |
/** | |
- * Asserts that haystack does not includes needle. | |
+ * Asserts that haystack does not include needle. | |
* | |
* T Type of values in haystack. | |
* @param haystack WeakSet container. | |
@@ -902,7 +905,7 @@ | |
notInclude<T extends object>(haystack: WeakSet<T>, needle: T, message?: string): void; | |
/** | |
- * Asserts that haystack does not includes needle. | |
+ * Asserts that haystack does not include needle. | |
* | |
* T Type of haystack. | |
* @param haystack Object. | |
@@ -937,7 +940,7 @@ | |
): void; | |
/** | |
- * Asserts that haystack does not includes needle. | |
+ * Asserts that haystack does not include needle. | |
* | |
* T Type of haystack. | |
* @param haystack Object. | |
@@ -947,7 +950,7 @@ | |
deepInclude<T>(haystack: T, needle: T extends WeakSet<any> ? never : Partial<T>, message?: string): void; | |
/** | |
- * Asserts that haystack does not includes needle. Deep equality is used. | |
+ * Asserts that haystack does not include needle. Deep equality is used. | |
* | |
* @param haystack Container string. | |
* @param needle Potential substring of haystack. | |
@@ -958,7 +961,7 @@ | |
notDeepInclude(haystack: string, needle: string, message?: string): void; | |
/** | |
- * Asserts that haystack does not includes needle. Deep equality is used. | |
+ * Asserts that haystack does not include needle. Deep equality is used. | |
* | |
* T Type of values in haystack. | |
* @param haystack Container array, set or map. | |
@@ -972,7 +975,7 @@ | |
): void; | |
/** | |
- * Asserts that haystack does not includes needle. Deep equality is used. | |
+ * Asserts that haystack does not include needle. Deep equality is used. | |
* | |
* T Type of haystack. | |
* @param haystack Object. | |
@@ -1106,7 +1109,7 @@ | |
property<T>(object: T, property: string, /* keyof T */ message?: string): void; | |
/** | |
- * Asserts that object has a property named by property. | |
+ * Asserts that object does not have a property named by property. | |
* | |
* T Type of object. | |
* @param object Container object. | |
@@ -1484,6 +1487,19 @@ | |
includeDeepMembers<T>(superset: T[], subset: T[], message?: string): void; | |
/** | |
+ * Asserts that `subset` isn't included in `superset` in any order. Uses a | |
+ * deep equality check. Duplicates are ignored. | |
+ * | |
+ * assert.notIncludeDeepMembers([ { a: 1 }, { b: 2 }, { c: 3 } ], [ { b: 2 }, { f: 5 } ], 'not include deep members'); | |
+ * | |
+ * T Type of set values. | |
+ * @param superset Actual set of values. | |
+ * @param subset Potential contained set of values. | |
+ * @param message Message to display on error. | |
+ */ | |
+ notIncludeDeepMembers<T>(superset: T[], subset: T[], message?: string): void; | |
+ | |
+ /** | |
* Asserts that non-object, non-array value inList appears in the flat array list. | |
* | |
* T Type of list values. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment