@jblib/should 0.0.2 → 0.0.3

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/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@jblib/should",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "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.3"
   },
   "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 }

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-import { shouldBeTrue } from "./should-be-true.js";
-export { shouldBeTrue };

package/dist/index.js

@@ -1,3 +0,0 @@
-import { shouldBeTrue } from "./should-be-true.js";
-
-export { shouldBeTrue };

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

@@ -1,5 +0,0 @@
-//#region src/should-be-true.d.ts
-declare const shouldBeTrue: (v: unknown, message?: string) => void;
-//#endregion
-export { shouldBeTrue };
-//# sourceMappingURL=should-be-true.d.ts.map

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

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

package/dist/should-be-true.js

@@ -1,8 +0,0 @@
-//#region src/should-be-true.ts
-const shouldBeTrue = (v, message) => {
-	if (v !== true) throw new Error(message ?? `should be true, but got ${String(v)}`);
-};
-
-//#endregion
-export { shouldBeTrue };
-//# sourceMappingURL=should-be-true.js.map

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

@@ -1 +0,0 @@
-{"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"}