@kensio/smartass 0.1.0 → 0.1.2

package/README.md

@@ -51,3 +51,6 @@ npm install @kensio/smartass
 - [assertTypeNumeric](src/assert/type-numeric/type-numeric.assert.ts)
 - [assertTypeObject](src/assert/type-object/type-object.assert.ts)
 - [assertTypeString](src/assert/type-string/type-string.assert.ts)
+- [assertInstanceOf](src/assert/instance-of/instance-of.assert.ts)
+- [assertThrowsError](src/assert/throws-error/throws-error.assert.ts)
+- [assertThrowsErrorAsync](src/assert/throws-error-async/throws-error-async.assert.ts)

package/dist/assert/instance-of/instance-of.assert.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Assertion function that checks if a value is an instance of a given class, with type-narrowing.
+ */
+export declare function assertInstanceOf<T>(value: unknown, classConstructor: abstract new (...args: never[]) => T, message?: string): asserts value is T;
+//# sourceMappingURL=instance-of.assert.d.ts.map

package/dist/assert/instance-of/instance-of.assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance-of.assert.d.ts","sourceRoot":"","sources":["../../../src/assert/instance-of/instance-of.assert.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,KAAK,EAAE,OAAO,EACd,gBAAgB,EAAE,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EACtD,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,KAAK,IAAI,CAAC,CASpB"}

package/dist/assert/instance-of/instance-of.assert.js

@@ -0,0 +1,11 @@
+import { AssertionError } from "../../assertion-error.js";
+/**
+ * Assertion function that checks if a value is an instance of a given class, with type-narrowing.
+ */
+export function assertInstanceOf(value, classConstructor, message) {
+    if (!(value instanceof classConstructor)) {
+        throw new AssertionError(message ??
+            `Expected value to be instance of ${classConstructor.name}, but it was not.`, value, `instanceof ${classConstructor.name}`);
+    }
+}
+//# sourceMappingURL=instance-of.assert.js.map

package/dist/assert/instance-of/instance-of.assert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance-of.assert.js","sourceRoot":"","sources":["../../../src/assert/instance-of/instance-of.assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAc,EACd,gBAAsD,EACtD,OAAgB;IAEhB,IAAI,CAAC,CAAC,KAAK,YAAY,gBAAgB,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,cAAc,CACtB,OAAO;YACL,oCAAoC,gBAAgB,CAAC,IAAI,mBAAmB,EAC9E,KAAK,EACL,cAAc,gBAAgB,CAAC,IAAI,EAAE,CACtC,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/assert/throws-error/throws-error.assert.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Assertion function that verifies a given function throws an error.
+ * Returns the thrown error for further assertions.
+ * Note this function does not apply type-narrowing via an assertion signature.
+ */
+export declare function assertThrowsError(fn: () => unknown, message?: string): Error;
+//# sourceMappingURL=throws-error.assert.d.ts.map

package/dist/assert/throws-error/throws-error.assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"throws-error.assert.d.ts","sourceRoot":"","sources":["../../../src/assert/throws-error/throws-error.assert.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAoB5E"}

package/dist/assert/throws-error/throws-error.assert.js

@@ -0,0 +1,21 @@
+import { AssertionError } from "../../assertion-error.js";
+import { desc } from "../../describe/describe.js";
+/**
+ * Assertion function that verifies a given function throws an error.
+ * Returns the thrown error for further assertions.
+ * Note this function does not apply type-narrowing via an assertion signature.
+ */
+export function assertThrowsError(fn, message) {
+    try {
+        fn();
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            return error;
+        }
+        throw new AssertionError(message ??
+            `Expected ${desc(fn)} to throw Error, but it threw ${desc(error)}.`, error, Error);
+    }
+    throw new AssertionError(message ?? `Expected ${desc(fn)} to throw, but it did not.`, undefined, Error);
+}
+//# sourceMappingURL=throws-error.assert.js.map

package/dist/assert/throws-error/throws-error.assert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throws-error.assert.js","sourceRoot":"","sources":["../../../src/assert/throws-error/throws-error.assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAElD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAAiB,EAAE,OAAgB;IACnE,IAAI,CAAC;QACH,EAAE,EAAE,CAAC;IACP,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,IAAI,cAAc,CACtB,OAAO;YACL,YAAY,IAAI,CAAC,EAAE,CAAC,iCAAiC,IAAI,CAAC,KAAK,CAAC,GAAG,EACrE,KAAK,EACL,KAAK,CACN,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,cAAc,CACtB,OAAO,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC,4BAA4B,EAC3D,SAAS,EACT,KAAK,CACN,CAAC;AACJ,CAAC"}

package/dist/assert/throws-error-async/throws-error-async.assert.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Assertion function that verifies an async function throws an error.
+ * Returns the thrown error for further assertions.
+ */
+export declare function assertThrowsErrorAsync(fn: () => Promise<unknown>, message?: string): Promise<Error>;
+//# sourceMappingURL=throws-error-async.assert.d.ts.map

package/dist/assert/throws-error-async/throws-error-async.assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"throws-error-async.assert.d.ts","sourceRoot":"","sources":["../../../src/assert/throws-error-async/throws-error-async.assert.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAsB,sBAAsB,CAC1C,EAAE,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC1B,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,KAAK,CAAC,CAoBhB"}

package/dist/assert/throws-error-async/throws-error-async.assert.js

@@ -0,0 +1,20 @@
+import { AssertionError } from "../../assertion-error.js";
+import { desc } from "../../describe/describe.js";
+/**
+ * Assertion function that verifies an async function throws an error.
+ * Returns the thrown error for further assertions.
+ */
+export async function assertThrowsErrorAsync(fn, message) {
+    try {
+        await fn();
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            return error;
+        }
+        throw new AssertionError(message ??
+            `Expected ${desc(fn)} to throw Error, but it threw ${desc(error)}.`, error, Error);
+    }
+    throw new AssertionError(message ?? `Expected ${desc(fn)} to throw, but it did not.`, undefined, Error);
+}
+//# sourceMappingURL=throws-error-async.assert.js.map

package/dist/assert/throws-error-async/throws-error-async.assert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throws-error-async.assert.js","sourceRoot":"","sources":["../../../src/assert/throws-error-async/throws-error-async.assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAElD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,EAA0B,EAC1B,OAAgB;IAEhB,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,IAAI,cAAc,CACtB,OAAO;YACL,YAAY,IAAI,CAAC,EAAE,CAAC,iCAAiC,IAAI,CAAC,KAAK,CAAC,GAAG,EACrE,KAAK,EACL,KAAK,CACN,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,cAAc,CACtB,OAAO,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC,4BAA4B,EAC3D,SAAS,EACT,KAAK,CACN,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -1,9 +1,12 @@
 export * from "./assert/identical/identical.assert.js";
+export * from "./assert/instance-of/instance-of.assert.js";
 export * from "./assert/non-nullable/non-nullable.assert.js";
 export * from "./assert/not-empty/not-empty.assert.js";
 export * from "./assert/number-between/number-between.assert.js";
 export * from "./assert/number-to-nearest/number-to-nearest.assert.js";
 export * from "./assert/one-of/one-of.assert.js";
+export * from "./assert/throws-error-async/throws-error-async.assert.js";
+export * from "./assert/throws-error/throws-error.assert.js";
 export * from "./assert/type-bigint/type-bigint.assert.js";
 export * from "./assert/type-boolean/type-boolean.assert.js";
 export * from "./assert/type-function/type-function.assert.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wCAAwC,CAAC;AACvD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AACvD,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AACvD,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,kCAAkC,CAAC;AACjD,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC"}

package/dist/index.js

@@ -1,9 +1,12 @@
 export * from "./assert/identical/identical.assert.js";
+export * from "./assert/instance-of/instance-of.assert.js";
 export * from "./assert/non-nullable/non-nullable.assert.js";
 export * from "./assert/not-empty/not-empty.assert.js";
 export * from "./assert/number-between/number-between.assert.js";
 export * from "./assert/number-to-nearest/number-to-nearest.assert.js";
 export * from "./assert/one-of/one-of.assert.js";
+export * from "./assert/throws-error-async/throws-error-async.assert.js";
+export * from "./assert/throws-error/throws-error.assert.js";
 export * from "./assert/type-bigint/type-bigint.assert.js";
 export * from "./assert/type-boolean/type-boolean.assert.js";
 export * from "./assert/type-function/type-function.assert.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wCAAwC,CAAC;AACvD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AACvD,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AACvD,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,kCAAkC,CAAC;AACjD,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC"}

package/package.json

@@ -4,7 +4,7 @@
   "author": "Kensio Software",
   "repository": "https://github.com/KensioSoftware/smartass",
   "license": "AGPL-3.0",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",