npm install errr\n\n## TypeScript (strict mode)\n`appendTo` accepts `unknown`, so a caught error from `try/catch` flows in directly under\n`useUnknownInCatchVariables` (enabled by `\"strict\": true`). `null` / `undefined` are skipped;\nany other non-`Error` value (string, plain object, number, etc.) is normalized to\n`new Error(...)` internally — no per-call `toError` shim is needed.\n
\nimport Errr from \"errr\";\n\ntry {\n return await PostgresProxy.getPrismaClient().leagueSafeMember.findMany({where: {leagueSafeLeagueId}});\n} catch (err) {\n Errr.newError(\"Could not get leagueSafeMember\")\n .appendTo(err) // err: unknown — accepted directly\n .debug({leagueSafeLeagueId})\n .throw();\n}\n\n\n## Optional stack trace cleanup\nBy default, `error.stack` is left as Node produces it. To shorten stacks for logs, set the environment variable **`ERRR_CLEAN_STACK`** to **`1`**, **`true`**, or **`yes`** (case-insensitive). When enabled, errr rewrites stacks when building an error: it removes leading frames that point at this package under `node_modules/errr`, and removes `node_modules` frames that appear after the first frame whose path is not under `node_modules`. Appended stacks (after the `FROM` line) are cleaned the same way, separately. This is best-effort path matching; turn it off if you need the full raw stack.\n\n## Adjusting stack trace length\nYou can control the number of frames captured in a stack trace using the native Node.js / V8 property **`Error.stackTraceLimit`**. For example, to capture more or fewer frames than the default (10), you can set this globally in your application:\n\nError.stackTraceLimit = 25; // Capture more frames for deeper stacks\n\nThis can also be set via the environment variable **`NODE_OPTIONS=\"--stack-trace-limit=25\"`**. Note that `errr` will still append debug parameters and other stacks regardless of this limit.\n\n## Testing stack debug params\nWhen asserting that `.debug({ ... })` output appears in `error.stack`, use **`formatDebugParams`** so tests stay aligned with errr’s formatting (prefix + `util.inspect` with `depth: 5`, `compact: false`). The same helper powers production stack building in `_build_`.\n
\nimport Errr, { formatDebugParams } from \"errr\";\n\nconst params = { actual: true, expected: false };\nconst err = Errr.newError(\"mismatch\").debug(params).get();\nconst fragment = formatDebugParams(params);\n\nexpect(err.stack.split(fragment).length).to.eql(2); // debug block present once\n\nNamed exports: `formatDebugParams`, `inspectDebugParams` (inspect only, no prefix), `DebugPrefix`, `defaultDebugInspectOptions`. Optional second argument merges overrides onto the default inspect options. Formatting changes that affect output (prefix, depth, compact) are treated as semver-visible; Node version differences in `util.inspect` output may still vary slightly across runtimes.\n\n## Example\n\n// debug, set, and appendTo are optional\n// Throws an error\n\ntry {\n Errr.newError(message, template).debug(this.debugParams)\n .set(\"reason\", someReason).set(\"statusCode\", 404)\n .appendTo(someError).throw();\n} catch (err) {\n let reason = err.reason; // Get value from someReason\n let allDebugParams = err.getAllDebugParams() // Get an array of all the debug params from all appended errors\n}\n\n\n\n// Returns an error.\nlet errr = Errr.newError(message, template).debug(this.debugParams)\n .set(\"reason\", someReason).set(\"statusCode\", 404)\n .appendTo(someError).get();\n \nlet reason = errr.reason; // Get value from someReason\nlet allDebugParams = errr.getAllDebugParams() // Get an array of all the debug params from all appended errors\n\n
\n\n\n## Example Output\n
\nError: [0d7c45075935b73716643af5] Some Error\n at ErrrorrrBuilder._build_ (/Users/corybillparrish/workspace/errr/lib/error-builder.js:89:17)\n at ErrrorrrBuilder.get (/Users/corybillparrish/workspace/errr/lib/error-builder.js:73:17)\n at Object.context.entryPointObject.run (/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1297:74)\n at FromSynchronousScenario.test (/Users/corybillparrish/workspace/errr/node_modules/maddox/lib/scenarios/functional/from-synchronous-scenario.js:17:46)\n at Context.\n\n## NPM Scripts\n1. npm run test - Run linter and unit tests.\n2. npm run ut - Use Maddox to Run Unit Tests.\n3. npm run perf - Use Maddox to Performance metrics.\n3. npm run uap - Use Maddox to Unit Tests and Performance metrics.\n4. npm run lint - Run linter.\n5. npm run docs - Rebuild public API Docs.\n\n## API\n\n(/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1309:10)\n at callFnAsync (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:338:8)\n at Test.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:290:7)\n at Runner.runTest (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:422:10)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:533:12\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:342:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:352:7\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:284:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:315:7\n at done (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:276:5)\n at callFn (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:333:7)\n at Hook.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:308:7)\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:298:10)\n at Immediate._onImmediate (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:320:5)\n at processImmediate [as _immediateCallback] (timers.js:383:17)\n\nDebug Params: {\n \"someParam\": \"c926b1d07df0749bc61b7cfc\"\n}\n\n ------------------------- FROM -------------------------\n\nError: [79f35d4d75e0653e6ff3b0f0] Some Error 3\n at ErrrorrrBuilder._build_ (/Users/corybillparrish/workspace/errr/lib/error-builder.js:89:17)\n at ErrrorrrBuilder.get (/Users/corybillparrish/workspace/errr/lib/error-builder.js:73:17)\n at Object.context.setupAppendErrors (/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1277:43)\n at Context. (/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1303:15)\n at callFnAsync (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:338:8)\n at Test.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:290:7)\n at Runner.runTest (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:422:10)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:533:12\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:342:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:352:7\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:284:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:315:7\n at done (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:276:5)\n at callFn (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:333:7)\n at Hook.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:308:7)\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:298:10)\n at Immediate._onImmediate (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:320:5)\n at processImmediate [as _immediateCallback] (timers.js:383:17)\n\n ------------------------- FROM -------------------------\n\nError: [880a280e670b68a4f2d0efc6] Some Error 2\n at ErrrorrrBuilder._build_ (/Users/corybillparrish/workspace/errr/lib/error-builder.js:89:17)\n at ErrrorrrBuilder.get (/Users/corybillparrish/workspace/errr/lib/error-builder.js:73:17)\n at Object.context.setupAppendErrors (/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1268:43)\n at Context. (/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1303:15)\n at callFnAsync (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:338:8)\n at Test.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:290:7)\n at Runner.runTest (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:422:10)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:533:12\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:342:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:352:7\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:284:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:315:7\n at done (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:276:5)\n at callFn (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:333:7)\n at Hook.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:308:7)\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:298:10)\n at Immediate._onImmediate (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:320:5)\n at processImmediate [as _immediateCallback] (timers.js:383:17)\n\nDebug Params: {\n \"someParam2\": \"7e8a3ef64acc245d87ce49f0\"\n}\n\n ------------------------- FROM -------------------------\n\nError: [cff70d396b7cac6ddf12c8c2] Some Error 1\n at ErrrorrrBuilder._build_ (/Users/corybillparrish/workspace/errr/lib/error-builder.js:89:17)\n at ErrrorrrBuilder.get (/Users/corybillparrish/workspace/errr/lib/error-builder.js:73:17)\n at Object.context.setupAppendErrors (/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1255:42)\n at Context. (/Users/corybillparrish/workspace/errr/spec/unit/errr-spec.js:1303:15)\n at callFnAsync (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:338:8)\n at Test.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:290:7)\n at Runner.runTest (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:422:10)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:533:12\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:342:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:352:7\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:284:14)\n at /Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:315:7\n at done (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:276:5)\n at callFn (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:333:7)\n at Hook.Runnable.run (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runnable.js:308:7)\n at next (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:298:10)\n at Immediate._onImmediate (/Users/corybillparrish/workspace/errr/node_modules/mocha/lib/runner.js:320:5)\n at processImmediate [as _immediateCallback] (timers.js:383:17)\n
Error Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging.
\nStatic class that contains the 'newError' factory function. Use the 'newError' factory function to return an ErrrorrrBuilder instance.
\nError Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging.
\nError Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging.
\nErrrorrrBuilder\n * [.set(key, value, [force])](#Error+set) ⇒ ErrrorrrBuilder\n * [.setAll(object, [force])](#Error+setAll) ⇒ ErrrorrrBuilder\n * [.appendTo(err)](#Error+appendTo) ⇒ ErrrorrrBuilder\n * [.get()](#Error+get) ⇒ [Error](#Error)\n * [.throw()](#Error+throw)\n\n\n\n### new Error([message], [template])\nProvides an interface to build an error. Then allows you to get or throw the error.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| [message] | String | Error message that will supplied to Error Object. |\n| [template] | Array | Array of parameters. If given, util.format(message, template) will be applied to the message string. |\n\n\n\n### error.debug(params, [shouldDebug]) ⇒ ErrrorrrBuilder\nAdd parameters to the stack trace that will make it easier to debug the problem. These values will appear in a\nin an object labeled \"Debug Params\" in the stack trace. You may call the 'debug' function as many times as you'd\nlike on an ErrrorrrBuilder instance. If the same key is passed in many times, the time it is passed in, will be\nthe value that appears in the stack trace.\n\nUnlike the 'set' function, which merges 'set' values from different Errr instances with its own instance, the debug\nparams start as an empty object for each Errr instance. They are attached to the stack trace and then forgotten.\n\n**Kind**: instance method of [Error](#Error) \n**Returns**: ErrrorrrBuilder - - Returns the instance of errorBuilder to allow chainability. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| params | Object | Object Map of key value parameters that will make it easier to debug the error. |\n| [shouldDebug] | Boolean | If shouldDebug === false, then debug params will not print. Any other value (including undefined), and the debug params will be printed. Useful if you want to only print debugParams given an Environment Variable. |\n\n\n\n### error.set(key, value, [force]) ⇒ ErrrorrrBuilder\nSets a value on the error object using the key as the variable name. Values added using the 'set' function will\nbe appended to new error objects when using the the .appendTo function. I.e. the values on the appendTo err will be\ncopied to the new error. These values are immutable though unless you use the 'force' value. As soon as you set\na value with a given key, it cannot be reset unless you pass in 'true' for the force variable.\n\nThe reason for enforcing an immutable paradigm, is to allow for values to be set on the error object at the level\nwhere the error was originally thrown (seemingly where the most important info will come from). This allows the user\nto set a value such as 'reason' on the error object at all level of your code, but only the most important reason will\nvalue will persist on the error object.\n\n**Kind**: instance method of [Error](#Error) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| key | String | The key that will be used to set the value on the error object. |\n| value | Object | The value that will be set on the object. |\n| [force] | Boolean | If force equals true, then this value will override a value with the same key from an errr passed in using the 'appendTo' function. |\n\n\n\n### error.setAll(object, [force]) ⇒ ErrrorrrBuilder\nSame concept and functionality as the 'set' function. The difference is that you can set all values in a\ngiven object onto the Errr instance.\n\nFollows the same immutable paradigm as the 'set' function. The difference is that you are setting the force override\nfor all value in the given object.\n\nSee set to understand functionality better.\n\n**Kind**: instance method of [Error](#Error) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| object | Object | Many key / value pairs to be set on the object. |\n| [force] | Boolean | If force equals true, then this value will override a value with the same key from an errr passed in using the 'appendTo' function. |\n\n\n\n### error.appendTo(err) ⇒ ErrrorrrBuilder\nAppend the error being built, to the end of this error's stack trace.\n\n**Kind**: instance method of [Error](#Error) \n**Returns**: ErrrorrrBuilder - - Returns the instance of errorBuilder to allow chainability. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| err | [Error](#Error) | The stack trace of the error being built, will be appended to this error's stack trace. |\n\n\n\n### error.get() ⇒ [Error](#Error)\nReturns a new Error object using the given parameters from the builder.\n\n**Kind**: instance method of [Error](#Error) \n**Returns**: [Error](#Error) - - Returns a new Error object using the given parameters from the builder. \n\n\n### error.throw()\nThrows a new Error object using the given parameters from the builder.\n\n**Kind**: instance method of [Error](#Error) \n**Throws**:\n\n- [Error](#Error) - Throws a new Error object using the given parameters from the builder.\n\n\n\n## Errr\nStatic class that contains the 'newError' factory function. Use the 'newError' factory function to return an ErrrorrrBuilder instance.\n\n**Kind**: global class \n\n* [Errr](#Errr)\n * [.newError([message], [template])](#Errr.newError) ⇒ [FromMessage](#FromMessage)\n * ~~[.fromError(err)](#Errr.fromError) ⇒ [FromError](#FromError)~~\n\n\n\n### Errr.newError([message], [template]) ⇒ [FromMessage](#FromMessage)\nGets a new ErrrorrrBuilder instance.\n\n**Kind**: static method of [Errr](#Errr) \n**Returns**: [FromMessage](#FromMessage) - Gets an ErrrorrrBuilder to get or throw an Error. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| [message] | String | Error message that will supplied to Error Object. |\n| [template] | Array | Array of parameters. If given, util.format(message, template) will be applied to the message string. |\n\n\n\n### ~~Errr.fromError(err) ⇒ [FromError](#FromError)~~\n***Deprecated***\n\n**Kind**: static method of [Errr](#Errr) \n**Returns**: [FromError](#FromError) - Gets an ErrrorrrBuilder to get or throw an Error. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| err | String | Will be used for the top level error and stack trace. |\n\n\n\n## FromError\nError Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging.\n\n**Kind**: global class \n\n\n### new FromError(error)\nProvides an interface to build an error from an error. Then allows you to get or throw the error.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| error | String | Will be used for the top level error and stack trace. |\n\n\n\n## FromMessage\nError Builder allows you to use optional functions to build an error object. The error can have appended stack traces and debug params to assist with debugging.\n\n**Kind**: global class \n\n\n### new FromMessage([message], [template])\nProvides an interface to build an error from a message. Then allows you to get or throw the error.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| [message] | String | Error message that will supplied to Error Object. If not given, empty string will be used for the error message. |\n| [template] | Array | Array of parameters. If given, util.format(message, template) will be applied to the message string. |\n\n","readmeFilename":"README.md","users":{"gerrard00":true}}