Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SqlErrorConstructor

Hierarchy

  • ErrorConstructor
    • SqlErrorConstructor

Callable

  • SqlErrorConstructor(message?: string): Error
  • SqlErrorConstructor(message?: string, options?: ErrorOptions): Error
  • Parameters

    • Optional message: string

    Returns Error

  • Parameters

    • Optional message: string
    • Optional options: ErrorOptions

    Returns Error

Index

Constructors

  • new SqlErrorConstructor(msg: string, sql?: string, fatal?: boolean, info?: { threadId?: number }, sqlState?: null | string, errno?: number, additionalStack?: string, addHeader?: boolean, cause?: unknown): mariadb.SqlError
  • new SqlErrorConstructor(message?: string): Error
  • new SqlErrorConstructor(message?: string, options?: ErrorOptions): Error
  • Parameters

    • msg: string
    • Optional sql: string
    • Optional fatal: boolean
    • Optional info: { threadId?: number }
      • Optional threadId?: number
    • Optional sqlState: null | string
    • Optional errno: number
    • Optional additionalStack: string
    • Optional addHeader: boolean
    • Optional cause: unknown

    Returns mariadb.SqlError

  • Parameters

    • Optional message: string

    Returns Error

  • Parameters

    • Optional message: string
    • Optional options: ErrorOptions

    Returns Error

Properties

prototype: mariadb.SqlError
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.

Methods

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • 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
    • Optional constructorOpt: Function

    Returns void

  • prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Generated using TypeDoc