@maxmind/minfraud-api-node
    Preparing search index...

    Class WebServiceError

    An error returned by the minFraud web service or encountered while communicating with it.

    In addition to the standard Error properties (including cause, which holds the underlying error when one exists, such as the network error behind a FETCH_ERROR), it exposes the code, status, and url associated with the failure.

    Hierarchy

    • Error
      • WebServiceError

    Implements

    Index

    Constructors

    • Parameters

      • properties: { code: WebServiceErrorCode; error: string; status?: number; url: string }
      • Optionaloptions: { cause?: unknown }

      Returns WebServiceError

    Properties

    cause?: unknown

    The underlying error that caused this one, when available (for example, the network error behind a FETCH_ERROR).

    The error code returned by the web service or generated by this client.

    error: string

    A human-readable description of the error. This is an alias of message, retained for backward compatibility.

    message: string
    name: string
    stack?: string
    status?: number

    The HTTP status code, when the error originated from an HTTP response.

    Declared with declare so that no class field is emitted: the property is absent (rather than set to undefined) when no status applies, e.g. on network-level errors such as FETCH_ERROR and NETWORK_TIMEOUT.

    url: string

    The URL that was being requested when the error occurred.

    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

    • 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