Pike LSP TypeScript API - v0.1.0-alpha.20
    Preparing search index...

    Class PikeError

    Error that originates from the Pike subprocess.

    Pike errors typically involve:

    • Pike compilation failures
    • Pike runtime errors
    • Invalid Pike code being analyzed
    try {
    const result = await this.pike.analyze(code);
    } catch (cause) {
    throw new PikeError('pike compilation failed', cause);
    }

    Hierarchy (View Summary)

    Index

    Constructors

    • Create a new PikeError.

      Parameters

      • message: string

        Human-readable error message

      • Optionalcause: Error

        The underlying error that caused this error

      Returns PikeError

    Properties

    cause?: Error

    The underlying error that caused this error (if any). Overrides Error.cause from the base Error class.

    layer: ErrorLayer

    The layer where this error occurred.

    message: string
    name: string
    stack?: 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.

    Accessors

    • get chain(): string

      Get the full error chain as a readable string.

      Returns string

    • get chainErrors(): Error[]

      Get all errors in the chain as an array.

      Returns Error[]

    Methods

    • Returns a string representation of an object.

      Returns string

    • 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

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

      https://v8.dev/docs/stack-trace-api#customizing-stack-traces