@jblib/should 0.0.2 → 0.0.4

package/README.md

@@ -0,0 +1,13 @@
+# jblib should
+
+helpful assertions and conditions for typescript.
+
+```ts
+import { shouldNever } from '@jblib/should'
+
+const obj = {
+  field: in?.thing ?? shouldNever()
+}
+```
+
+fail loudly in conditions that should never be met!

package/dist/index.d.ts

@@ -1,2 +1,4 @@
+import { shouldBeFalse } from "./should-be-false.js";
 import { shouldBeTrue } from "./should-be-true.js";
-export { shouldBeTrue };
+import { shouldNever } from "./should-never.js";
+export { shouldBeFalse, shouldBeTrue, shouldNever };

package/dist/index.js

@@ -1,3 +1,5 @@
+import { shouldBeFalse } from "./should-be-false.js";
 import { shouldBeTrue } from "./should-be-true.js";
+import { shouldNever } from "./should-never.js";
 
-export { shouldBeTrue };
+export { shouldBeFalse, shouldBeTrue, shouldNever };

package/dist/should-be-false.d.ts

@@ -0,0 +1,13 @@
+//#region src/should-be-false.d.ts
+/**
+ * shouldBeFalse checks if the provided value is strictly false.
+ * If it is not, it throws an error.
+ *
+ * @param v value that should always be false
+ * @param message custom error message to throw if the value is not false
+ * @throws {Error} if the value is not false
+ */
+declare const shouldBeFalse: (v: unknown, message?: string) => void;
+//#endregion
+export { shouldBeFalse };
+//# sourceMappingURL=should-be-false.d.ts.map

package/dist/should-be-false.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"should-be-false.d.ts","names":[],"sources":["../src/should-be-false.ts"],"mappings":";;;;;;;;;cAQM,aAAA,GAAiB,CAAA,WAAY,OAAA"}

package/dist/should-be-false.js

@@ -0,0 +1,16 @@
+//#region src/should-be-false.ts
+/**
+* shouldBeFalse checks if the provided value is strictly false.
+* If it is not, it throws an error.
+*
+* @param v value that should always be false
+* @param message custom error message to throw if the value is not false
+* @throws {Error} if the value is not false
+*/
+const shouldBeFalse = (v, message) => {
+	if (v !== false) throw new Error(message ?? `should be false, but got ${String(v)}`);
+};
+
+//#endregion
+export { shouldBeFalse };
+//# sourceMappingURL=should-be-false.js.map

package/dist/should-be-false.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"should-be-false.js","names":[],"sources":["../src/should-be-false.ts"],"sourcesContent":["/**\n * shouldBeFalse checks if the provided value is strictly false.\n * If it is not, it throws an error.\n *\n * @param v value that should always be false\n * @param message custom error message to throw if the value is not false\n * @throws {Error} if the value is not false\n */\nconst shouldBeFalse = (v: unknown, message?: string): void => {\n  if (v !== false) {\n    throw new Error(message ?? `should be false, but got ${String(v)}`)\n  }\n}\n\nexport { shouldBeFalse }\n"],"mappings":";;;;;;;;;AAQA,MAAM,iBAAiB,GAAY,YAA2B;AAC5D,KAAI,MAAM,MACR,OAAM,IAAI,MAAM,WAAW,4BAA4B,OAAO,EAAE,GAAG"}

package/dist/should-be-true.d.ts

@@ -1,4 +1,12 @@
 //#region src/should-be-true.d.ts
+/**
+ * shouldBeTrue checks if the provided value is strictly true.
+ * If it is not, it throws an error.
+ *
+ * @param v value that should always be true
+ * @param message custom error message to throw if the value is not true
+ * @throws {Error} if the value is not true
+ */
 declare const shouldBeTrue: (v: unknown, message?: string) => void;
 //#endregion
 export { shouldBeTrue };

package/dist/should-be-true.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"should-be-true.d.ts","names":[],"sources":["../src/should-be-true.ts"],"mappings":";cAAM,YAAA,GAAgB,CAAA,WAAY,OAAA"}
+{"version":3,"file":"should-be-true.d.ts","names":[],"sources":["../src/should-be-true.ts"],"mappings":";;;;;;;;;cAQM,YAAA,GAAgB,CAAA,WAAY,OAAA"}

package/dist/should-be-true.js

@@ -1,4 +1,12 @@
 //#region src/should-be-true.ts
+/**
+* shouldBeTrue checks if the provided value is strictly true.
+* If it is not, it throws an error.
+*
+* @param v value that should always be true
+* @param message custom error message to throw if the value is not true
+* @throws {Error} if the value is not true
+*/
 const shouldBeTrue = (v, message) => {
 	if (v !== true) throw new Error(message ?? `should be true, but got ${String(v)}`);
 };

package/dist/should-be-true.js.map

@@ -1 +1 @@
-{"version":3,"file":"should-be-true.js","names":[],"sources":["../src/should-be-true.ts"],"sourcesContent":["const shouldBeTrue = (v: unknown, message?: string): void => {\n  if (v !== true) {\n    throw new Error(message ?? `should be true, but got ${String(v)}`)\n  }\n}\n\nexport { shouldBeTrue }\n"],"mappings":";AAAA,MAAM,gBAAgB,GAAY,YAA2B;AAC3D,KAAI,MAAM,KACR,OAAM,IAAI,MAAM,WAAW,2BAA2B,OAAO,EAAE,GAAG"}
+{"version":3,"file":"should-be-true.js","names":[],"sources":["../src/should-be-true.ts"],"sourcesContent":["/**\n * shouldBeTrue checks if the provided value is strictly true.\n * If it is not, it throws an error.\n *\n * @param v value that should always be true\n * @param message custom error message to throw if the value is not true\n * @throws {Error} if the value is not true\n */\nconst shouldBeTrue = (v: unknown, message?: string): void => {\n  if (v !== true) {\n    throw new Error(message ?? `should be true, but got ${String(v)}`)\n  }\n}\n\nexport { shouldBeTrue }\n"],"mappings":";;;;;;;;;AAQA,MAAM,gBAAgB,GAAY,YAA2B;AAC3D,KAAI,MAAM,KACR,OAAM,IAAI,MAAM,WAAW,2BAA2B,OAAO,EAAE,GAAG"}

package/dist/should-never.d.ts

@@ -0,0 +1,12 @@
+//#region src/should-never.d.ts
+/**
+ * shouldNever always throws an error when called.
+ * This is useful for failing in areas that should never be reached.
+ *
+ * @param message custom error message to throw if the value is called
+ * @throws {Error} if the value is called
+ */
+declare const shouldNever: (message?: string) => never;
+//#endregion
+export { shouldNever };
+//# sourceMappingURL=should-never.d.ts.map

package/dist/should-never.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"should-never.d.ts","names":[],"sources":["../src/should-never.ts"],"mappings":";;;;;;;;cAOM,WAAA,GAAe,OAAA"}

package/dist/should-never.js

@@ -0,0 +1,15 @@
+//#region src/should-never.ts
+/**
+* shouldNever always throws an error when called.
+* This is useful for failing in areas that should never be reached.
+*
+* @param message custom error message to throw if the value is called
+* @throws {Error} if the value is called
+*/
+const shouldNever = (message) => {
+	throw new Error(message ?? "should never be called");
+};
+
+//#endregion
+export { shouldNever };
+//# sourceMappingURL=should-never.js.map

package/dist/should-never.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"should-never.js","names":[],"sources":["../src/should-never.ts"],"sourcesContent":["/**\n * shouldNever always throws an error when called.\n * This is useful for failing in areas that should never be reached.\n *\n * @param message custom error message to throw if the value is called\n * @throws {Error} if the value is called\n */\nconst shouldNever = (message?: string): never => {\n  throw new Error(message ?? 'should never be called')\n}\n\nexport { shouldNever }\n"],"mappings":";;;;;;;;AAOA,MAAM,eAAe,YAA4B;AAC/C,OAAM,IAAI,MAAM,WAAW,yBAAyB"}

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@jblib/should",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "should, assertions that throw errors when conditions aren't met",
   "type": "module",
   "devDependencies": {
-    "vitest": "^4.1.5",
-    "typescript": "^6.0.3",
     "prettier": "^3.8.3",
     "tsdown": "^0.21.10",
-    "@jblib/eslint": "0.0.1"
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5",
+    "@jblib/eslint": "0.0.4"
   },
   "keywords": [
     "should",

package/src/index.ts

@@ -1,3 +1,3 @@
-import { shouldBeTrue } from './should-be-true.js'
-
-export { shouldBeTrue }
+export { shouldBeFalse } from './should-be-false.js'
+export { shouldBeTrue } from './should-be-true.js'
+export { shouldNever } from './should-never.js'

package/src/should-be-false.ts

@@ -1,3 +1,11 @@
+/**
+ * shouldBeFalse checks if the provided value is strictly false.
+ * If it is not, it throws an error.
+ *
+ * @param v value that should always be false
+ * @param message custom error message to throw if the value is not false
+ * @throws {Error} if the value is not false
+ */
 const shouldBeFalse = (v: unknown, message?: string): void => {
   if (v !== false) {
     throw new Error(message ?? `should be false, but got ${String(v)}`)

package/src/should-be-true.ts

@@ -1,3 +1,11 @@
+/**
+ * shouldBeTrue checks if the provided value is strictly true.
+ * If it is not, it throws an error.
+ *
+ * @param v value that should always be true
+ * @param message custom error message to throw if the value is not true
+ * @throws {Error} if the value is not true
+ */
 const shouldBeTrue = (v: unknown, message?: string): void => {
   if (v !== true) {
     throw new Error(message ?? `should be true, but got ${String(v)}`)

package/src/should-never.spec.ts

@@ -0,0 +1,9 @@
+import { describe, expect, it } from 'vitest'
+
+import { shouldNever } from './should-never.js'
+
+describe('should never', () => {
+  it('should always throw', () => {
+    expect(() => shouldNever()).toThrow()
+  })
+})

package/src/should-never.ts

@@ -0,0 +1,12 @@
+/**
+ * shouldNever always throws an error when called.
+ * This is useful for failing in areas that should never be reached.
+ *
+ * @param message custom error message to throw if the value is called
+ * @throws {Error} if the value is called
+ */
+const shouldNever = (message?: string): never => {
+  throw new Error(message ?? 'should never be called')
+}
+
+export { shouldNever }