Senzing Node.js SDK
    Preparing search index...

    Class SzError

    Base class for all Senzing errors. Every error thrown by the SDK is an instance of SzError (or one of its subclasses), so a single catch block can handle the entire hierarchy.

    try {
      engine.getRecord("CUSTOMERS", "9999");
    } catch (e) {
      if (e instanceof SzError) {
        console.log(`[${e.category}/${e.severity}] ${e.message}`);
        console.log(`Retryable: ${e.isRetryable()}, BadInput: ${e.isBadInput()}`);
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    szCode code? component? category severity stackTraceLimit cause? name message stack?

    Methods

    isRetryable isUnrecoverable isBadInput isDatabase isLicense isConfiguration isInitialization captureStackTrace prepareStackTrace

    Constructors

    Properties

    szCode: string
    code?: number
    component?: string
    category: string
    severity: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    cause?: unknown
    name: string
    message: string
    stack?: string

    Methods

    • Returns true when the operation can safely be retried after a short delay.

      Returns boolean

    • Returns true when the error is unrecoverable and the process should be restarted.

      Returns boolean

    • Returns true when the caller supplied invalid input (bad record, unknown key, etc.).

      Returns boolean

    • Returns true when the error indicates the engine has not been initialized.

      Returns boolean

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods