diff options
author | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
---|---|---|
committer | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
commit | 703e03aba33f234712206769f57717ba7d92d23d (patch) | |
tree | 0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/serialize-error/index.d.ts | |
parent | ab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff) | |
download | FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst |
Added export_allowed file to make repository visible in cgit
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; |