diff options
| author | Priyansh <[email protected]> | 2020-12-22 17:49:59 +0530 |
|---|---|---|
| committer | Priyansh <[email protected]> | 2020-12-22 17:49:59 +0530 |
| commit | e93da8b04da86773247aadb1cbb1912e4f4526b2 (patch) | |
| tree | eb4ef3203a92ed3dbd2252ddb1ea23bd2d670c98 /node_modules/serialize-error/index.d.ts | |
| parent | a5743c293dcb435e4b159a4df791f8955a4110ec (diff) | |
| download | styx-e93da8b04da86773247aadb1cbb1912e4f4526b2.tar.xz styx-e93da8b04da86773247aadb1cbb1912e4f4526b2.zip | |
Rewriting Project
Diffstat (limited to 'node_modules/serialize-error/index.d.ts')
| -rw-r--r-- | node_modules/serialize-error/index.d.ts | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/node_modules/serialize-error/index.d.ts b/node_modules/serialize-error/index.d.ts new file mode 100644 index 0000000..714dc9f --- /dev/null +++ b/node_modules/serialize-error/index.d.ts @@ -0,0 +1,58 @@ +import {Primitive, JsonObject} from 'type-fest'; + +export type ErrorObject = { + name?: string; + stack?: string; + message?: string; + code?: string; +} & JsonObject; + +/** +Serialize an `Error` object into a plain object. + +Non-error values are passed through. +Custom properties are preserved. +Circular references are handled. + +@example +``` +import {serializeError} from 'serialize-error'; + +const error = new Error('🦄'); + +console.log(error); +//=> [Error: 🦄] + +console.log(serializeError(error)); +//=> {name: 'Error', message: '🦄', stack: 'Error: 🦄\n at Object.<anonymous> …'} +``` +*/ +export function serializeError<ErrorType>(error: ErrorType): ErrorType extends Primitive + ? ErrorType + : ErrorObject; + +/** +Deserialize a plain object or any value into an `Error` object. + +`Error` objects are passed through. +Non-error values are wrapped in a `NonError` error. +Custom properties are preserved. +Non-enumerable properties are kept non-enumerable (name, message, stack). +Enumerable properties are kept enumerable (all properties besides the non-enumerable ones). +Circular references are handled. + +@example +``` +import {deserializeError} from 'serialize-error'; + +const error = deserializeError({ + message: 'aaa', + stack: 'at <anonymous>:1:13' +}); + +console.log(error); +// Error: aaa +// at <anonymous>:1:13 +``` +*/ +export function deserializeError(errorObject: ErrorObject | unknown): Error; |
