Class CorjMaker

constructor

• new CorjMaker(options): CorjMaker

• Parameters

  • options: CorjMakerOptions

  Returns CorjMaker

options

cloneWith

• cloneWith(options?): CorjMaker

• Parameters

  • options: {
        asJsonFormatsToApply?: [CorjAsJsonFormat, ...CorjAsJsonFormat[]];
        asStringFormatsToApply?: [CorjAsStringFormat, ...CorjAsStringFormat[]];
        childrenMetadataFields?: boolean | {
            $schema?: boolean;
            as_json_format?: boolean;
            as_string_format?: boolean;
            children_sources?: boolean;
            v?: boolean;
        };
        childrenSources?: string[];
        makeReportId?: ((context) => string);
        maxChildrenLevel?: number;
        metadataFields?: boolean | {
            $schema?: boolean;
            as_json_format?: boolean;
            as_string_format?: boolean;
            children_sources?: boolean;
            v?: boolean;
        };
        onCaughtMaking?: null | CorjMakerOnCaughtMakingCallbackFn;
        parseStackToArray?: boolean;
        printWarningsOnUnhandledErrors?: boolean;
    } = CORJ_MAKER_DEFAULT_OPTIONS

    • Optional asJsonFormatsToApply?: [CorjAsJsonFormat, ...CorjAsJsonFormat[]]

    • Optional asStringFormatsToApply?: [CorjAsStringFormat, ...CorjAsStringFormat[]]

    • Optional childrenMetadataFields?: boolean | {
          $schema?: boolean;
          as_json_format?: boolean;
          as_string_format?: boolean;
          children_sources?: boolean;
          v?: boolean;
      }

    • Optional childrenSources?: string[]

      Fields to use as children.

    • Optional makeReportId?: ((context) => string)

      • • (context): string

        • Parameters

          • context: {
                caught: unknown;
                index: number;
                level: number;
                path: string;
            }

            • caught: unknown

            • index: number

            • level: number

            • path: string

          Returns string

    • Optional maxChildrenLevel?: number

      Controls how much levels of nested errors will be included. For example

      • 1 means caught.cause is included, but caught.cause.cause is not.
      • 2 means caught.cause.cause is included, but caught.cause.cause.cause is not.

    • Optional metadataFields?: boolean | {
          $schema?: boolean;
          as_json_format?: boolean;
          as_string_format?: boolean;
          children_sources?: boolean;
          v?: boolean;
      }

      Controls adding metadata fields to report.

    • Optional onCaughtMaking?: null | CorjMakerOnCaughtMakingCallbackFn

      This function is called when CorjMaker.makeReportObject fails to produce along the way of producing a report.

    • Optional parseStackToArray?: boolean

    • Optional printWarningsOnUnhandledErrors?: boolean

      Print warning when onCaughtMaking is not set, or when onCaughtMaking itself threw an error.

  Returns CorjMaker

makeReportArray

• makeReportArray(caught): CaughtObjectReportJsonChild[]

• Parameters

  • caught: unknown

  Returns CaughtObjectReportJsonChild[]

makeReportArrayEntries

• makeReportArrayEntries(caught): CaughtObjectReportJsonNestedEntries[]

• Parameters

  • caught: unknown

  Returns CaughtObjectReportJsonNestedEntries[]

makeReportObject

• makeReportObject(caught): CaughtObjectReportJson

• Parameters

  • caught: unknown

  Returns CaughtObjectReportJson

makeReportObjectEntries

• makeReportObjectEntries(caught): CaughtObjectReportJsonEntries

• This exists to produce entries in dependable order.

  Parameters

  • caught: unknown

  Returns CaughtObjectReportJsonEntries

Static withDefaults

• withDefaults(options?): CorjMaker

• Parameters

  • options: {
        asJsonFormatsToApply?: [CorjAsJsonFormat, ...CorjAsJsonFormat[]];
        asStringFormatsToApply?: [CorjAsStringFormat, ...CorjAsStringFormat[]];
        childrenMetadataFields?: boolean | {
            $schema?: boolean;
            as_json_format?: boolean;
            as_string_format?: boolean;
            children_sources?: boolean;
            v?: boolean;
        };
        childrenSources?: string[];
        makeReportId?: ((context) => string);
        maxChildrenLevel?: number;
        metadataFields?: boolean | {
            $schema?: boolean;
            as_json_format?: boolean;
            as_string_format?: boolean;
            children_sources?: boolean;
            v?: boolean;
        };
        onCaughtMaking?: null | CorjMakerOnCaughtMakingCallbackFn;
        parseStackToArray?: boolean;
        printWarningsOnUnhandledErrors?: boolean;
    } = CORJ_MAKER_DEFAULT_OPTIONS

    • Optional asJsonFormatsToApply?: [CorjAsJsonFormat, ...CorjAsJsonFormat[]]

    • Optional asStringFormatsToApply?: [CorjAsStringFormat, ...CorjAsStringFormat[]]

    • Optional childrenMetadataFields?: boolean | {
          $schema?: boolean;
          as_json_format?: boolean;
          as_string_format?: boolean;
          children_sources?: boolean;
          v?: boolean;
      }

    • Optional childrenSources?: string[]

      Fields to use as children.

    • Optional makeReportId?: ((context) => string)

      • • (context): string

        • Parameters

          • context: {
                caught: unknown;
                index: number;
                level: number;
                path: string;
            }

            • caught: unknown

            • index: number

            • level: number

            • path: string

          Returns string

    • Optional maxChildrenLevel?: number

      Controls how much levels of nested errors will be included. For example

      • 1 means caught.cause is included, but caught.cause.cause is not.
      • 2 means caught.cause.cause is included, but caught.cause.cause.cause is not.

    • Optional metadataFields?: boolean | {
          $schema?: boolean;
          as_json_format?: boolean;
          as_string_format?: boolean;
          children_sources?: boolean;
          v?: boolean;
      }

      Controls adding metadata fields to report.

    • Optional onCaughtMaking?: null | CorjMakerOnCaughtMakingCallbackFn

      This function is called when CorjMaker.makeReportObject fails to produce along the way of producing a report.

    • Optional parseStackToArray?: boolean

    • Optional printWarningsOnUnhandledErrors?: boolean

      Print warning when onCaughtMaking is not set, or when onCaughtMaking itself threw an error.

  Returns CorjMaker