docs: add quixzoom-auth-core product to AAMOS
- Product documentation in docs/products/ - Updated MEMORY.md with product info - quiXzoom Auth Core as AAMOS Identity product
This commit is contained in:
+112
@@ -0,0 +1,112 @@
|
||||
# serialize-error
|
||||
|
||||
> Serialize/deserialize an error into a plain object
|
||||
|
||||
Useful if you for example need to `JSON.stringify()` or `process.send()` the error.
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install serialize-error
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const {serializeError, deserializeError} = require('serialize-error');
|
||||
|
||||
const error = new Error('🦄');
|
||||
|
||||
console.log(error);
|
||||
//=> [Error: 🦄]
|
||||
|
||||
const serialized = serializeError(error)
|
||||
|
||||
console.log(serialized);
|
||||
//=> {name: 'Error', message: '🦄', stack: 'Error: 🦄\n at Object.<anonymous> …'}
|
||||
|
||||
const deserialized = deserializeError(serialized);
|
||||
|
||||
console.log(deserialized);
|
||||
//=> [Error: 🦄]
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### serializeError(value, options?)
|
||||
|
||||
Type: `Error | unknown`
|
||||
|
||||
Serialize an `Error` object into a plain object.
|
||||
|
||||
Non-error values are passed through.
|
||||
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).
|
||||
Buffer properties are replaced with `[object Buffer]`.
|
||||
Circular references are handled.
|
||||
If the input object has a `.toJSON()` method, then it's called instead of serializing the object's properties.
|
||||
It's up to `.toJSON()` implementation to handle circular references and enumerability of the properties.
|
||||
|
||||
`.toJSON` example:
|
||||
|
||||
```js
|
||||
class ErrorWithDate extends Error {
|
||||
constructor() {
|
||||
super();
|
||||
this.date = new Date();
|
||||
}
|
||||
}
|
||||
const error = new ErrorWithDate();
|
||||
serializeError(date);
|
||||
// => {date: '1970-01-01T00:00:00.000Z', name, message, stack}
|
||||
|
||||
class ErrorWithToJSON extends Error {
|
||||
constructor() {
|
||||
super('🦄');
|
||||
this.date = new Date();
|
||||
}
|
||||
|
||||
toJSON() {
|
||||
return serializeError(this);
|
||||
}
|
||||
}
|
||||
const error = new ErrorWithToJSON();
|
||||
console.log(serializeError(error));
|
||||
// => {date: '1970-01-01T00:00:00.000Z', message: '🦄', name, stack}
|
||||
```
|
||||
|
||||
### deserializeError(value, options?)
|
||||
|
||||
Type: `{[key: string]: unknown} | unknown`
|
||||
|
||||
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.
|
||||
Circular references are handled.
|
||||
|
||||
### options
|
||||
|
||||
Type: `object`
|
||||
|
||||
#### maxDepth
|
||||
|
||||
Type: `number`\
|
||||
Default: `Number.POSITIVE_INFINITY`
|
||||
|
||||
The maximum depth of properties to preserve when serializing/deserializing.
|
||||
|
||||
```js
|
||||
const {serializeError} = require('serialize-error');
|
||||
|
||||
const error = new Error('🦄');
|
||||
error.one = {two: {three: {}}};
|
||||
|
||||
console.log(serializeError(error, {maxDepth: 1}));
|
||||
//=> {name: 'Error', message: '…', one: {}}
|
||||
|
||||
console.log(serializeError(error, {maxDepth: 2}));
|
||||
//=> {name: 'Error', message: '…', one: { two: {}}}
|
||||
```
|
||||
Reference in New Issue
Block a user