CWE API Client - v1.0.1
    Preparing search index...

    Class CweApiError

    Thrown when the CWE API returns a non-2xx response.

    import { CweApiError } from 'cwe-api-client';

    try {
      await cwe.weakness(99999).get();
    } catch (err) {
      if (err instanceof CweApiError) {
        console.log(err.status);     // 404
        console.log(err.statusText); // 'Not Found'
        console.log(err.message);    // 'CWE API error: 404 Not Found'
      }
    }

    Hierarchy

    • Error
      • CweApiError
    Index

    Constructors

    constructor

    Properties

    stackTraceLimit status statusText name message stack?

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    Properties

    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.

    status: number

    HTTP status code (e.g. 404, 400, 500)

    statusText: string

    HTTP status text (e.g. 'Not Found', 'Bad Request')

    name: string
    message: string
    stack?: string

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods