caught-object-report-json - npm Package Compare versions

Comparing version 7.1.2 to 7.1.3

index.d.ts

@@ -77,3 +77,3 @@ export type CaughtObjectReportJson = {
      */
-    children?: (CaughtObjectReportJsonChildren | null)[];
+    children?: (CaughtObjectReportJsonChild | null)[];
     /**
@@ -137,3 +137,3 @@ * Is set if this `caught` object has fields reported in `children_sources`, but they were omitted by implementation.
 };
-export type CaughtObjectReportJsonChildren = CaughtObjectReportJson & {
+export type CaughtObjectReportJsonChild = CaughtObjectReportJson & {
     id: string;
@@ -147,4 +147,4 @@ path: string;
 export type CaughtObjectReportJsonNestedEntries = [
-    keyof CaughtObjectReportJsonChildren,
-    CaughtObjectReportJsonChildren[keyof CaughtObjectReportJsonChildren]
+    keyof CaughtObjectReportJsonChild,
+    CaughtObjectReportJsonChild[keyof CaughtObjectReportJsonChild]
 ][];
@@ -282,3 +282,3 @@ export type CaughtObjectReportJsonEntries = [
     makeReportArrayEntries(caught: unknown): CaughtObjectReportJsonNestedEntries[];
-    makeReportArray(caught: unknown): CaughtObjectReportJsonChildren[];
+    makeReportArray(caught: unknown): CaughtObjectReportJsonChild[];
     static withDefaults(options?: DeepPartialOptions<CorjMakerOptions>): CorjMaker;
@@ -298,3 +298,3 @@ cloneWith(options?: DeepPartialOptions<CorjMakerOptions>): CorjMaker;
  */
-export declare function makeCaughtObjectReportJsonArray(caught: unknown, options?: DeepPartialOptions<CorjMakerOptions>): CaughtObjectReportJsonChildren[];
+export declare function makeCaughtObjectReportJsonArray(caught: unknown, options?: DeepPartialOptions<CorjMakerOptions>): CaughtObjectReportJsonChild[];
 /**
@@ -301,0 +301,0 @@ * Alias for {@link makeCaughtObjectReportJsonArray}.

package.json

 {
   "name": "caught-object-report-json",
-  "version": "7.1.2",
+  "version": "7.1.3",
   "description": "JS Error JSON representation",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

@@ -27,4 +27,6 @@ # Caught Object Report JSON
     * [makeCaughtObjectReportJson(caught)](#makecaughtobjectreportjsoncaught)
+    * [makeCaughtObjectReportJsonArray(caught)](#makecaughtobjectreportjsonarray--caught-)
     * [new CorjMaker(options)](#new-corjmakeroptions)
     * [type CaughtObjectReportJson](#type-caughtobjectreportjson)
+    * [type CaughtObjectReportJsonChild](#type-caughtobjectreportjsonchild)
 * [Links](#links)
@@ -693,2 +695,6 @@ * [GitHub](#github)
 
+#### [makeCaughtObjectReportJsonArray(caught)](https://dany-fedorov.github.io/caught-object-report-json/functions/makeCaughtObjectReportJson.html)
+
+A wrapper for `CorjMaker#makeCaughtObjectReportJsonArray` with default options.
+
 #### [new CorjMaker(options)](https://dany-fedorov.github.io/caught-object-report-json/classes/CorjMaker.html)
@@ -698,3 +704,3 @@
 Use `CorjMaker#makeReportObject` instance method to produce `CaughtObjectReportJson`.<br>
-Use `CorjMaker#makeReportArray` instance method to produce `CaughtObjectReportJsonChildren[]`.
+Use `CorjMaker#makeReportArray` instance method to produce `CaughtObjectReportJsonChild[]`.
 
@@ -705,5 +711,6 @@ #### [type CaughtObjectReportJson](https://dany-fedorov.github.io/caught-object-report-json/types/CaughtObjectReportJson.html)
 
-#### [type CaughtObjectReportJsonChildren](https://dany-fedorov.github.io/caught-object-report-json/types/CaughtObjectReportJsonChildren.html)
+#### [type CaughtObjectReportJsonChild](https://dany-fedorov.github.io/caught-object-report-json/types/CaughtObjectReportJsonChild.html)
 
-Report object produced by `CorjMaker#makeReportArray`.
+Report object produced in array by `CorjMaker#makeReportArray`, or in top-level `children` property
+on `CaughtObjectReportJson`.
 
@@ -710,0 +717,0 @@ # Links

No alert changes

Improved metrics

Total package byte prevSize

88919

0.5%

Number of lines in readme file

737

0.96%

No dependency changes