caught-object-report-json
Advanced tools
Error object as JSON.details field.Error object can have nested errors,
see AggregateError
and cause property.
This can be a custom property of course like rootCauses. This means that occasionally an error you catch can be a
deeply nested tree.throw statement to any object, not just to Error instances. For
example throw Infinity is valid JS code.unknown.All these things make serializing caught object to JSON a non-trivial problem.
This library attempts to provide a useful JSON representation for any JS object thrown and caught.
Intended use cases are
Please don't hesitate to open an issue if your use case for this type of library is not met.
Consider
JSON.stringify(err, Object.getOwnPropertyNames(err)) is good enough if you don't necessarily want all edge cases
covered.JSON.stringify can throw, so make sure to wrap it in try catch or use safe-stable-stringify to avoid common
errors of converting to JSON like circular references or converting BigInt value.Compared to the method above, caught-object-report-json gives you the following benefits
throw null or when accessing a property on the error throws. Just
slap caught-object-report-json on anything.caught-object-report-json fails to produce complete report, it will tell you why.Object.getOwnPropertyNames will apply to nested errors, but they can have a
different set of property names, and you can miss on something important.
caught-object-report-json does not have this problem.caught-object-report-json flattens nested errors. Array is more suitable for processing than
nested object. For example, you can write a pseudocode search condition like this with JSONPath
query - $.children[:].constructor_name == "SyntaxError". It will search through all children in flattened array
no matter how deeply nested. Same is not easily attainable for nested objects.caught-object-report-json guarantees a JSON format which is
(Run with npm run ts-file ./examples/example-1-syntax-error.ts)
try {
JSON.parse(undefined);
} catch (caught: unknown) {
const report = makeCaughtObjectReportJson(caught);
console.log(JSON.stringify(report, null, 2));
}
prints
{
"instanceof_error": true,
"typeof": "object",
"constructor_name": "SyntaxError",
"message": "Unexpected token u in JSON at position 0",
"as_string": "SyntaxError: Unexpected token u in JSON at position 0",
"as_json": {},
"stack": "SyntaxError: Unexpected token u in JSON at position 0\n at JSON.parse (<anonymous>)\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-1-syntax-error.ts:6:8)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)",
"children_sources": [
"cause",
"errors"
],
"as_string_format": "String",
"as_json_format": "safe-stable-stringify@2.4.1",
"v": "corj/v0.6"
}
AxiosError#toJSON does not include response headers and response
data (issue), so you'll have to add it yourself.
(Run with npm run ts-file ./examples/example-2-axios-error.ts)
const axiosClient = axios.create();
class AxiosErrorWrapper extends AxiosError {
error: AxiosError;
constructor(error: AxiosError) {
super(
error.message,
error.code,
error.config,
error.request,
error.response,
);
this.error = error;
}
override toJSON = function(this: AxiosErrorWrapper) {
return {
...this.error.toJSON(),
...(!this.error.response
? {}
: {
response_data: this.error.response.data,
response_headers: this.error.response.headers,
}),
};
};
}
axiosClient.interceptors.response.use(undefined, (error) => {
if (error instanceof AxiosError) {
return Promise.reject(new AxiosErrorWrapper(error));
}
return Promise.reject(error);
});
(async () => {
try {
await axiosClient.get('https://reqres.in/api/users/23');
} catch (caught: unknown) {
const report = makeCaughtObjectReportJson(caught);
console.log(JSON.stringify(report, null, 2));
}
})();
prints
{
"instanceof_error": true,
"typeof": "object",
"constructor_name": "AxiosErrorWrapper",
"message": "Request failed with status code 404",
"as_string": "AxiosError: Request failed with status code 404",
"as_json": {
"message": "Request failed with status code 404",
"name": "AxiosError",
"stack": "AxiosError: Request failed with status code 404\n at settle (/home/user/work-dir/caught-object-report-json/node_modules/axios/lib/core/settle.js:19:12)\n at IncomingMessage.handleStreamEnd (/home/user/work-dir/caught-object-report-json/node_modules/axios/lib/adapters/http.js:505:11)\n at IncomingMessage.emit (node:events:525:35)\n at IncomingMessage.emit (node:domain:489:12)\n at endReadableNT (node:internal/streams/readable:1359:12)\n at processTicksAndRejections (node:internal/process/task_queues:82:21)",
"config": {
"transitional": {
"silentJSONParsing": true,
"forcedJSONParsing": true,
"clarifyTimeoutError": false
},
"adapter": [
"xhr",
"http"
],
"transformRequest": [
null
],
"transformResponse": [
null
],
"timeout": 0,
"xsrfCookieName": "XSRF-TOKEN",
"xsrfHeaderName": "X-XSRF-TOKEN",
"maxContentLength": -1,
"maxBodyLength": -1,
"env": {},
"headers": {
"Accept": "application/json, text/plain, */*",
"User-Agent": "axios/1.2.1",
"Accept-Encoding": "gzip, compress, deflate, br"
},
"method": "get",
"url": "https://reqres.in/api/users/23"
},
"code": "ERR_BAD_REQUEST",
"status": 404,
"response_data": {},
"response_headers": {
"date": "Sat, 28 Jan 2023 19:10:32 GMT",
"content-type": "application/json; charset=utf-8",
"content-length": "2",
"connection": "close",
"x-powered-by": "Express",
"access-control-allow-origin": "*",
"etag": "W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\"",
"via": "1.1 vegur",
"cache-control": "max-age=14400",
"cf-cache-status": "EXPIRED",
"report-to": "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=1L5F50uGk8AGGDKIk2WHHM8L2xV13XnA%2FJbD9EVofkAK0nW9uVfqOZOtPTg2amWpxM17WWe2IM%2BYRBE6Vyr49Z6nELCdbyEuEHkOVpz%2F8U5Stl3BQK93EgFNhw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
"nel": "{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}",
"vary": "Accept-Encoding",
"server": "cloudflare",
"cf-ray": "790c075efba977b0-KBP"
}
},
"stack": "AxiosError: Request failed with status code 404\n at /home/user/work-dir/caught-object-report-json/examples/example-2-axios-error.ts:35:27\n at processTicksAndRejections (node:internal/process/task_queues:95:5)",
"children_sources": [
"cause",
"errors"
],
"as_string_format": "String",
"as_json_format": "safe-stable-stringify@2.4.1",
"v": "corj/v0.6"
}
If you do not provide onCaughtMaking callback, then errors are reported by default reporter using console.warn
function. Provide onCaughtMaking: null to opt out of it.
(Run with npm run ts-file ./examples/example-3-not-error-object.ts)
try {
throw undefined;
} catch (caught: unknown) {
const report = makeCaughtObjectReportJson(caught, {
onCaughtMaking: (caught, context) => {
console.log("onCaughtMaking::", { context });
console.log("onCaughtMaking::", { caught });
}
});
console.log(JSON.stringify(report, null, 2));
}
prints form onCaughtMaking callback
onCaughtMaking:: {
context: {
reason: 'error-converting-caught-to-json',
caughtObjectNestingInfo: null,
caughtWhenProcessingReportKey: 'as_json'
}
}
onCaughtMaking:: {
caught: Error: Could not convert caught object to json string using safe-stable-stringify@2.4.1.
at makeProp_as_json (/home/user/work-dir/caught-object-report-json/src/index.ts:546:19)
at makeEntriesWithoutNested (/home/user/work-dir/caught-object-report-json/src/index.ts:903:20)
at CorjMaker.entries (/home/user/work-dir/caught-object-report-json/src/index.ts:951:46)
at CorjMaker.makeReportObject (/home/user/work-dir/caught-object-report-json/src/index.ts:965:36)
at makeCaughtObjectReportJson (/home/user/work-dir/caught-object-report-json/src/index.ts:353:42)
}
and then prints form catch block
{
"instanceof_error": false,
"typeof": "undefined",
"as_string": "undefined",
"as_json": null,
"children_sources": [
"cause",
"errors"
],
"as_string_format": "String",
"as_json_format": "safe-stable-stringify@2.4.1",
"v": "corj/v0.6"
}
Use metadataFields option to control what metadata to add to report. There is a similar
option childrenMetadataFields that controls metadata fields for children reports. By default metadata is not set for
children reports.
(Run with npm run ts-file ./examples/example-4-metadata-fields.ts)
try {
throw new Error(`Hi, I'm a regular Error object.`);
} catch (caught: unknown) {
const report = makeCaughtObjectReportJson(caught, {
metadataFields: {
$schema: true,
as_json_format: false,
as_string_format: false,
children_sources: false,
v: false
},
});
console.log(JSON.stringify(report, null, 2));
}
prints
{
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "Hi, I'm a regular Error object.",
"as_string": "Error: Hi, I'm a regular Error object.",
"as_json": {},
"stack": "Error: Hi, I'm a regular Error object.\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-4-metadata-fields.ts:4:9)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)",
"$schema": "https://raw.githubusercontent.com/dany-fedorov/caught-object-report-json/main/schema-versions/corj/v0.7-report-object.json"
}
JS has two standard ways to represent nested/children errors.
AggregateError
has nested errors accessible in errors propertycause property
of Error class.Caught Object Report JSON abstracts this into children property.
In the following example AggregateError has both errors and cause properties set.
On a JSON report children_sources metadata field tells which property names were used to obtain children array.
Children in array have three additional fields - child_id, child_path and child_level.
child_id is an integer id assigned to a nested error object, starts from 0child_path is a JSONPath from root caught object to this object.child_level shows a level of this object in a tree of nested error objects.(Run with npm run ts-file ./examples/example-5-nested-errors-1-basic.ts)
const caught = new AggregateError(
[
new Error('AggregateError child 0'),
'AggregateError child 1 (not an Error object)',
],
'AggregateError message',
{ cause: new Error('Cause Error object') },
);
const report = makeCaughtObjectReportJson(caught, {
metadataFields: {
$schema: false,
as_json_format: false,
as_string_format: false,
v: false,
children_sources: true,
},
});
console.log(JSON.stringify(report, null, 2));
prints
{
"instanceof_error": true,
"typeof": "object",
"constructor_name": "AggregateError",
"message": "AggregateError message",
"as_string": "AggregateError: AggregateError message",
"as_json": {},
"stack": "AggregateError: AggregateError message\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-5-nested-errors-1-basic.ts:7:16)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)",
"children": [
{
"id": "0",
"path": "$.cause",
"level": 1,
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "Cause Error object",
"as_string": "Error: Cause Error object",
"as_json": {},
"stack": "Error: Cause Error object\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-5-nested-errors-1-basic.ts:13:12)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)"
},
{
"id": "1",
"path": "$.errors[0]",
"level": 1,
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "AggregateError child 0",
"as_string": "Error: AggregateError child 0",
"as_json": {},
"stack": "Error: AggregateError child 0\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-5-nested-errors-1-basic.ts:9:5)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)"
},
{
"id": "2",
"path": "$.errors[1]",
"level": 1,
"instanceof_error": false,
"typeof": "string",
"constructor_name": "String",
"as_string": "AggregateError child 1 (not an Error object)",
"as_json": "AggregateError child 1 (not an Error object)"
}
],
"children_sources": [
"cause",
"errors"
]
}
The following example showcases some nuances of processing nested errors.
maxChildrenLevel option set to 2, "lvl 3" errors are not includedmaxChildrenLevel
setting, children_omitted_reason
field is addedchildrenSources option includes nestedError field, it is included in children arraychildrenSources option includes nestedError field, it is excluded from as_json fieldchildren prop for nested objects includes list of child_ids and not objectschildrenSources is an array, then report is made for each element and not for an
array as a whole.(Run with npm run ts-file ./examples/example-6-nested-errors-2-nesting-levels.ts)
const caught = new Error("lvl 0", {
cause: new Error("lvl 1; obj 0", {
cause: [
new Error("lvl 2; obj 0.0", { cause: new Error("lvl 3; obj 0.0.0") }),
new Error("lvl 2; obj 0.1")
]
})
});
caught.nestedErrors = 'lvl 1; obj 1';
caught.extraField = 'error info';
const report = makeCaughtObjectReportJson(caught, {
maxChildrenLevel: 2,
childrenSources: ['cause', 'errors', 'nestedErrors'],
metadataFields: {
$schema: false,
as_json_format: false,
as_string_format: false,
v: false,
children_sources: true
}
});
console.log(JSON.stringify(report, null, 2));
prints
{
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "lvl 0",
"as_string": "Error: lvl 0",
"as_json": {
"extraField": "error info"
},
"stack": "Error: lvl 0\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-6-nested-errors-2-nesting-levels.ts:5:16)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)",
"children": [
{
"id": "0",
"path": "$.cause",
"level": 1,
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "lvl 1; obj 0",
"as_string": "Error: lvl 1; obj 0",
"as_json": {},
"stack": "Error: lvl 1; obj 0\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-6-nested-errors-2-nesting-levels.ts:9:5)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)",
"children": [
"2",
"3"
]
},
{
"id": "1",
"path": "$.nestedError",
"level": 1,
"instanceof_error": false,
"typeof": "string",
"constructor_name": "String",
"as_string": "lvl 1; obj 1",
"as_json": "lvl 1; obj 1"
},
{
"id": "2",
"path": "$.cause.cause[0]",
"level": 2,
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "lvl 2; obj 0.0",
"as_string": "Error: lvl 2; obj 0.0",
"as_json": {},
"stack": "Error: lvl 2; obj 0.0\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-6-nested-errors-2-nesting-levels.ts:13:9)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)",
"children_omitted_reason": "Reached max depth - 2"
},
{
"id": "3",
"path": "$.cause.cause[1]",
"level": 2,
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "lvl 2; obj 0.1",
"as_string": "Error: lvl 2; obj 0.1",
"as_json": {},
"stack": "Error: lvl 2; obj 0.1\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-6-nested-errors-2-nesting-levels.ts:16:9)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)"
}
],
"children_sources": [
"cause",
"errors",
"nestedError"
]
}
(Run with npm run ts-file ./examples/example-7-using-corj-maker-instance.ts)
const corj = CorjMaker.withDefaults({
metadataFields: false
});
try {
throw new Error(`Hi, I'm a regular Error object.`);
} catch (caught: unknown) {
const report = corj.makeReportObject(caught);
console.log(JSON.stringify(report, null, 2));
}
prints
{
"instanceof_error": true,
"typeof": "object",
"constructor_name": "Error",
"message": "Hi, I'm a regular Error object.",
"as_string": "Error: Hi, I'm a regular Error object.",
"as_json": {},
"stack": "Error: Hi, I'm a regular Error object.\n at Object.<anonymous> (/home/user/work-dir/caught-object-report-json/examples/example-5-using-corj-maker-instance.ts:8:9)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)\n at phase4 (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:649:14)\n at bootstrap (/home/user/work-dir/caught-object-report-json/node_modules/ts-node/src/bin.ts:95:10)"
}
TODO: add explanation text
(Run with npm run ts-file ./examples/example-8-zod-error-flat-report.ts)
const corj = CorjMaker.withDefaults({
metadataFields: false,
});
const User = zod.object({
name: zod.string(),
age: zod.number().min(-250).max(250),
});
try {
const validatedStallmanObject = User.parse({ name: 'Richard Stallman' });
console.log('Hello, validated', validatedStallmanObject.name);
} catch (caught: unknown) {
const reportArray = corj.makeReportArray(caught);
console.log(JSON.stringify(reportArray, null, 2));
}
prints
[
{
"id": "root",
"path": "$",
"level": 0,
"instanceof_error": true,
"typeof": "object",
"constructor_name": "ZodError",
"message": "[\n {\n \"code\": \"invalid_type\",\n \"expected\": \"number\",\n \"received\": \"undefined\",\n \"path\": [\n \"age\"\n ],\n \"message\": \"Required\"\n }\n]",
"as_string": "[\n {\n \"code\": \"invalid_type\",\n \"expected\": \"number\",\n \"received\": \"undefined\",\n \"path\": [\n \"age\"\n ],\n \"message\": \"Required\"\n }\n]",
"as_json": {
"issues": [
{
"code": "invalid_type",
"expected": "number",
"received": "undefined",
"path": [
"age"
],
"message": "Required"
}
],
"name": "ZodError"
},
"stack": "ZodError: [\n {\n \"code\": \"invalid_type\",\n \"expected\": \"number\",\n \"received\": \"undefined\",\n \"path\": [\n \"age\"\n ],\n \"message\": \"Required\"\n }\n]\n at handleResult (/home/df/hdd/wd/caught-object-report-json/node_modules/zod/lib/types.js:29:23)\n at ZodObject.safeParse (/home/df/hdd/wd/caught-object-report-json/node_modules/zod/lib/types.js:142:16)\n at ZodObject.parse (/home/df/hdd/wd/caught-object-report-json/node_modules/zod/lib/types.js:122:29)\n at Object.<anonymous> (/home/df/hdd/wd/caught-object-report-json/examples/example-8-zod-error-flat-report.ts:14:40)\n at Module._compile (node:internal/modules/cjs/loader:1120:14)\n at Module.m._compile (/home/df/hdd/wd/caught-object-report-json/node_modules/ts-node/src/index.ts:1618:23)\n at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)\n at Object.require.extensions.<computed> [as .ts] (/home/df/hdd/wd/caught-object-report-json/node_modules/ts-node/src/index.ts:1621:12)\n at Module.load (node:internal/modules/cjs/loader:998:32)\n at Function.Module._load (node:internal/modules/cjs/loader:839:12)",
"children": [
"0"
],
"children_sources": [
"cause",
"errors"
],
"as_string_format": "String",
"as_json_format": "safe-stable-stringify@2.4.1",
"v": "corj/v0.8"
},
{
"id": "0",
"path": "$.errors[0]",
"level": 1,
"instanceof_error": false,
"typeof": "object",
"constructor_name": "Object",
"message": "Required",
"as_string": "[object Object]",
"as_json": {
"code": "invalid_type",
"expected": "number",
"received": "undefined",
"path": [
"age"
],
"message": "Required"
}
}
]
A wrapper for CorjMaker#makeReportObject with default options.
A wrapper for CorjMaker#makeCaughtObjectReportJsonArray with default options.
Use CorjMaker.withDefaults static method to construct a CorjMaker with default options.
Use CorjMaker#makeReportObject instance method to produce CaughtObjectReportJson.
Use CorjMaker#makeReportArray instance method to produce CaughtObjectReportJsonChild[].
Report object produced by CorjMaker#makeReportObject.
Report object produced in array by CorjMaker#makeReportArray, or in top-level children property
on CaughtObjectReportJson.
https://github.com/dany-fedorov/caught-object-report-json.git
https://www.npmjs.com/package/caught-object-report-json
https://deno.land/x/caught_object_report_json
FAQs
JS Error JSON representation
The npm package caught-object-report-json receives a total of 256 weekly downloads. As such, caught-object-report-json popularity was classified as not popular.
We found that caught-object-report-json demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The remediated findings include organization permission bugs, stale project access after transfers, OIDC replay edge cases, audit logging gaps, and an IDOR in API token deletion.
Research
/Security News
GitHub account BufferZoneCorp published sleeper packages that later added credential theft, GitHub Actions tampering, fake go wrappers, and SSH persistence.
Research
/Security News
Socket found a malicious Intercom PHP package on Packagist using Composer plugin execution to steal credentials and spread across ecosystems.