@types/assert - npm Package Compare versions

Comparing version 1.5.2 to 1.5.3

assert/index.d.ts

@@ -8,44 +8,6 @@ // Type definitions for commonjs-assert 1.5
 
-declare function assert(value: any, message?: string): asserts value;
-
+/** An alias of `assert.ok()`. */
+declare function assert(value: any, message?: string | Error): asserts value;
 declare namespace assert {
-    function fail(actual?: any, expected?: any, message?: string, operator?: string): never;
-
-    function ok(value: any, message?: string): asserts value;
-
-    /** @deprecated Use `strictEqual` instead */
-    function equal(actual: any, expected: any, message?: string): void;
-
-    /** @deprecated Use `notStrictEqual` instead */
-    function notEqual(actual: any, expected: any, message?: string): void;
-
-    /** @deprecated Use `deepStrictEqual` instead */
-    function deepEqual(actual: any, expected: any, message?: string): void;
-
-    /** @deprecated Use `notDeepStrictEqual` instead */
-    function notDeepEqual(actual: any, expected: any, message?: string): void;
-
-    function deepStrictEqual<T>(actual: any, expected: T, message?: string): asserts actual is T;
-
-    function notDeepStrictEqual(actual: any, expected: any, message?: string): void;
-
-    function strictEqual<T>(actual: any, expected: T, message?: string): asserts actual is T;
-
-    function notStrictEqual(actual: any, expected: any, message?: string): void;
-
-    function throws(block: () => void, message?: string): void;
-    function throws(block: () => void, error: (() => void) | ((err: any) => boolean) | RegExp, message?: string): void;
-
-    function doesNotThrow(block: () => void, message?: string): void;
-    function doesNotThrow(
-        block: () => void,
-        error: (() => void) | ((err: any) => boolean) | RegExp,
-        message?: string,
-    ): void;
-
-    function ifError(value: any): asserts value is null | undefined;
-
-    class AssertionError implements Error {
-        name: string;
-        message: string;
+    class AssertionError extends Error {
         actual: any;
@@ -55,15 +17,97 @@ expected: any;
         generatedMessage: boolean;
+        code: 'ERR_ASSERTION';
 
         constructor(options?: {
+            /** If provided, the error message is set to this value. */
             message?: string;
+            /** The `actual` property on the error instance. */
             actual?: any;
+            /** The `expected` property on the error instance. */
             expected?: any;
+            /** The `operator` property on the error instance. */
             operator?: string;
-            stackStartFunction?: () => void;
+            /** If provided, the generated stack trace omits frames before this function. */
+            // tslint:disable-next-line:ban-types
+            stackStartFn?: Function;
         });
     }
 
-    const strict: typeof assert;
+    type AssertPredicate = RegExp | (new () => object) | ((thrown: any) => boolean) | object | Error;
+
+    function fail(message?: string | Error): never;
+    /** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */
+    function fail(
+        actual: any,
+        expected: any,
+        message?: string | Error,
+        operator?: string,
+        // tslint:disable-next-line:ban-types
+        stackStartFn?: Function,
+    ): never;
+    function ok(value: any, message?: string | Error): asserts value;
+    /** @deprecated since v9.9.0 - use strictEqual() instead. */
+    function equal(actual: any, expected: any, message?: string | Error): void;
+    /** @deprecated since v9.9.0 - use notStrictEqual() instead. */
+    function notEqual(actual: any, expected: any, message?: string | Error): void;
+    /** @deprecated since v9.9.0 - use deepStrictEqual() instead. */
+    function deepEqual(actual: any, expected: any, message?: string | Error): void;
+    /** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */
+    function notDeepEqual(actual: any, expected: any, message?: string | Error): void;
+    function strictEqual<T>(actual: any, expected: T, message?: string | Error): asserts actual is T;
+    function notStrictEqual(actual: any, expected: any, message?: string | Error): void;
+    function deepStrictEqual<T>(actual: any, expected: T, message?: string | Error): asserts actual is T;
+    function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void;
+
+    function throws(block: () => any, message?: string | Error): void;
+    function throws(block: () => any, error: AssertPredicate, message?: string | Error): void;
+    function doesNotThrow(block: () => any, message?: string | Error): void;
+    function doesNotThrow(block: () => any, error: AssertPredicate, message?: string | Error): void;
+
+    function ifError(value: any): asserts value is null | undefined;
+
+    function rejects(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>;
+    function rejects(
+        block: (() => Promise<any>) | Promise<any>,
+        error: AssertPredicate,
+        message?: string | Error,
+    ): Promise<void>;
+    function doesNotReject(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>;
+    function doesNotReject(
+        block: (() => Promise<any>) | Promise<any>,
+        error: AssertPredicate,
+        message?: string | Error,
+    ): Promise<void>;
+
+    function match(value: string, regExp: RegExp, message?: string | Error): void;
+    function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void;
+
+    const strict: Omit<
+        typeof assert,
+        | 'equal'
+        | 'notEqual'
+        | 'deepEqual'
+        | 'notDeepEqual'
+        | 'ok'
+        | 'strictEqual'
+        | 'deepStrictEqual'
+        | 'ifError'
+        | 'strict'
+    > & {
+        (value: any, message?: string | Error): asserts value;
+        equal: typeof strictEqual;
+        notEqual: typeof notStrictEqual;
+        deepEqual: typeof deepStrictEqual;
+        notDeepEqual: typeof notDeepStrictEqual;
+
+        // Mapped types and assertion functions are incompatible?
+        // TS2775: Assertions require every name in the call target
+        // to be declared with an explicit type annotation.
+        ok: typeof ok;
+        strictEqual: typeof strictEqual;
+        deepStrictEqual: typeof deepStrictEqual;
+        ifError: typeof ifError;
+        strict: typeof strict;
+    };
 }
 
 export = assert;

assert/package.json

 {
     "name": "@types/assert",
-    "version": "1.5.2",
+    "version": "1.5.3",
     "description": "TypeScript definitions for commonjs-assert",
@@ -39,4 +39,4 @@ "license": "MIT",
     "dependencies": {},
-    "typesPublisherContentHash": "22e81543d29cedce99b156a9ed8dec1726dbd3ee8271b3f5247c7d1cb6d0a785",
-    "typeScriptVersion": "3.1"
+    "typesPublisherContentHash": "05a35c9aea312ea6b86537a1e846cef067f15d4499ce8985fbec353ba58fdc59",
+    "typeScriptVersion": "3.4"
 }

assert/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Tue, 01 Sep 2020 20:30:57 GMT
+ * Last updated: Tue, 12 Jan 2021 17:17:20 GMT
  * Dependencies: none
@@ -14,0 +14,0 @@ * Global values: none

assert/ts3.6/index.d.ts

@@ -1,36 +0,4 @@
-declare function assert(value: any, message?: string): void;
-
+/** An alias of `assert.ok()`. */
+declare function assert(value: any, message?: string | Error): void;
 declare namespace assert {
-    function fail(actual?: any, expected?: any, message?: string, operator?: string): never;
-
-    function ok(value: any, message?: string): void;
-
-    function equal(actual: any, expected: any, message?: string): void;
-
-    function notEqual(actual: any, expected: any, message?: string): void;
-
-    function deepEqual(actual: any, expected: any, message?: string): void;
-
-    function notDeepEqual(actual: any, expected: any, message?: string): void;
-
-    function deepStrictEqual(actual: any, expected: any, message?: string): void;
-
-    function notDeepStrictEqual(actual: any, expected: any, message?: string): void;
-
-    function strictEqual(actual: any, expected: any, message?: string): void;
-
-    function notStrictEqual(actual: any, expected: any, message?: string): void;
-
-    function throws(block: () => void, message?: string): void;
-    function throws(block: () => void, error: (() => void) | ((err: any) => boolean) | RegExp, message?: string): void;
-
-    function doesNotThrow(block: () => void, message?: string): void;
-    function doesNotThrow(
-        block: () => void,
-        error: (() => void) | ((err: any) => boolean) | RegExp,
-        message?: string,
-    ): void;
-
-    function ifError(value: any): void;
-
     class AssertionError implements Error {
@@ -43,12 +11,68 @@ name: string;
         generatedMessage: boolean;
+        code: 'ERR_ASSERTION';
 
         constructor(options?: {
+            /** If provided, the error message is set to this value. */
             message?: string;
+            /** The `actual` property on the error instance. */
             actual?: any;
+            /** The `expected` property on the error instance. */
             expected?: any;
+            /** The `operator` property on the error instance. */
             operator?: string;
-            stackStartFunction?: () => void;
+            /** If provided, the generated stack trace omits frames before this function. */
+            // tslint:disable-next-line:ban-types
+            stackStartFn?: Function;
         });
     }
 
+    type AssertPredicate = RegExp | (new () => object) | ((thrown: any) => boolean) | object | Error;
+
+    function fail(message?: string | Error): never;
+    /** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */
+    function fail(
+        actual: any,
+        expected: any,
+        message?: string | Error,
+        operator?: string,
+        // tslint:disable-next-line:ban-types
+        stackStartFn?: Function,
+    ): never;
+    function ok(value: any, message?: string | Error): void;
+    /** @deprecated since v9.9.0 - use strictEqual() instead. */
+    function equal(actual: any, expected: any, message?: string | Error): void;
+    /** @deprecated since v9.9.0 - use notStrictEqual() instead. */
+    function notEqual(actual: any, expected: any, message?: string | Error): void;
+    /** @deprecated since v9.9.0 - use deepStrictEqual() instead. */
+    function deepEqual(actual: any, expected: any, message?: string | Error): void;
+    /** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */
+    function notDeepEqual(actual: any, expected: any, message?: string | Error): void;
+    function strictEqual(actual: any, expected: any, message?: string | Error): void;
+    function notStrictEqual(actual: any, expected: any, message?: string | Error): void;
+    function deepStrictEqual(actual: any, expected: any, message?: string | Error): void;
+    function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void;
+
+    function throws(block: () => any, message?: string | Error): void;
+    function throws(block: () => any, error: AssertPredicate, message?: string | Error): void;
+    function doesNotThrow(block: () => any, message?: string | Error): void;
+    function doesNotThrow(block: () => any, error: AssertPredicate, message?: string | Error): void;
+
+    function ifError(value: any): void;
+
+    function rejects(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>;
+    function rejects(
+        block: (() => Promise<any>) | Promise<any>,
+        error: AssertPredicate,
+        message?: string | Error,
+    ): Promise<void>;
+    function doesNotReject(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>;
+    function doesNotReject(
+        block: (() => Promise<any>) | Promise<any>,
+        error: AssertPredicate,
+        message?: string | Error,
+    ): Promise<void>;
+
+    function match(value: string, regExp: RegExp, message?: string | Error): void;
+    function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void;
+
     const strict: typeof assert;
@@ -55,0 +79,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

11364

increased by59.74%

Lines of code

171

increased by94.32%

No dependency changes