jaypie 1.0.0 → 1.0.2

package/README.md

@@ -232,7 +232,7 @@ throw MultiError(errors);
 | `TeapotError`           | 418    | RFC 2324 section-2.3.2 |
 | `UnavailableError`      | 503    | The thing you are looking for cannot come to the phone right now |
 | `UnhandledError`        | 500    | An error that should have been handled wasn't |
-| `UnreachableCodeError`  | 500    |
+| `UnreachableCodeError`  | 500    | Should not be possible |
 
 ##### Special Errors
 
@@ -251,6 +251,8 @@ ALWAYS internal to the app, NEVER something the client did
     * If an unexpected error escapes the handler, Jaypie returns this when it is caught
 * Unreachable
     * In theory the block is literally not reachable and we want to put something there to make sure it stays that way
+    * For example, a complicated chain of `if`/`else` that should always return and cover all cases, may throw this as the last `else`
+    * A configuration error means what happened was possible but should not have happened, an unreachable error means it should not have been possible
 
 ### Functions
 
@@ -295,6 +297,7 @@ if (envBoolean("AWESOME", { defaultValue: true })) {
 #### `force`
 
 Coerce a value into a type or throw an error.
+Forcing arrays is the primary use case.
 
 ```javascript
 import { force } from "jaypie";
@@ -304,10 +307,9 @@ argument = force([thing], Array);
 // argument = [thing]
 ```
 
-Forcing arrays is the primary use case.
+`force` supports Array, Object, and String.
 
 ```javascript
-// force supports Array, Object, and String
 argument = force(argument, Array);
 argument = force(argument, Object, "key");
 argument = force(argument, String, "default");
@@ -343,7 +345,7 @@ The code for placeholders was written by Chris Ferdinandi and distributed under
 import { validate, VALIDATE } from "jaypie";
 
 validate(argument, {
-  type: TYPE.ANY,
+  type: VALIDATE.ANY,
   falsy: false,     // When `true`, allows "falsy" values that match the type (e.g., `0`, `""`)
   required: true,   // When `false`, allows `undefined` as a valid value
   throws: true      // When `false`, returns `false` instead of throwing error
@@ -407,7 +409,7 @@ Returns `true` to validate the request. Throw an error or return `false` to reje
 
 Called before the handler (e.g., connect to a database). Throw an error to halt execution.
 
-#### `handler: async Function`
+##### `handler: async Function`
 
 The main function to handle the request. Throw an error to halt execution.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jaypie",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "author": "Finlayson Studio",
   "type": "module",
   "main": "src/index.js",
@@ -17,25 +17,25 @@
     "test:spec:mongoose.package": "vitest run ./src/__tests__/mongoose.package.spec.js"
   },
   "dependencies": {
-    "@jaypie/core": "^0.5.8"
+    "@jaypie/core": "^1.0.2"
   },
   "devDependencies": {
-    "@jaypie/testkit": "^1.0.1",
+    "@jaypie/testkit": "^1.0.3",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-vitest": "^0.3.26",
+    "eslint-plugin-vitest": "^0.4.0",
     "hygen": "^6.2.11",
     "jest-extended": "^4.0.2",
     "prettier": "^3.2.5",
-    "sort-package-json": "^2.8.0",
+    "sort-package-json": "^2.9.0",
     "vitest": "^1.4.0"
   },
   "peerDependencies": {
-    "@jaypie/aws": "^0.1.3",
-    "@jaypie/lambda": "^0.1.9",
-    "@jaypie/mongoose": "^0.1.3"
+    "@jaypie/aws": "^1.0.0",
+    "@jaypie/lambda": "^1.0.0",
+    "@jaypie/mongoose": "^1.0.0"
   },
   "peerDependenciesMeta": {
     "@jaypie/aws": {