Welcome to the Comprehensive Guide to Stack Utils

Stack Utils is a versatile utility library for working with stacks in JavaScript. It provides a set of useful functions to manage stack traces, handle errors, and debug code effectively. In this guide, we will introduce Stack Utils and explain dozens of its useful APIs along with code snippets. Additionally, we will showcase a sample application using these APIs.

Installation

  npm install stack-utils

API Examples

Basic Setup

  const StackUtils = require('stack-utils');
  const stackUtils = new StackUtils({ internals: StackUtils.nodeInternals() });

Retrieving Cleaned Stack

  const error = new Error('Something went wrong');
  const cleanedStack = stackUtils.clean(error.stack);
  console.log(cleanedStack);

Parsing Stack Trace

  const parsedStack = stackUtils.parse(error.stack);
  console.log(parsedStack);

Getting Call Site Information

  const callSite = stackUtils.capture(function myFunction() {
    /* function code */
  });
  console.log(callSite);

Creating a Custom Stack Trace

  const customStack = stackUtils.at('myFile.js:10');
  console.log(customStack);

Filtering Stack Trace

  const filterOptions = {
    frames: 1,
    internals: StackUtils.nodeInternals()
  };
  const filteredStack = stackUtils.callSite(error, filterOptions);
  console.log(filteredStack);

Detecting Error Origins

  const errorOrigin = stackUtils.callSiteOrigin(error.stack);
  console.log(errorOrigin);

Sample Application

  const StackUtils = require('stack-utils');

  // Initialize StackUtils
  const stackUtils = new StackUtils({ internals: StackUtils.nodeInternals() });

  // Example Function to trigger error
  function triggerError() {
    throw new Error('Example Error');
  }

  try {
    triggerError();
  } catch (error) {
    // Capture and clean stack trace
    const cleanedStack = stackUtils.clean(error.stack);
    console.log('Cleaned Stack:', cleanedStack);

    // Parse the stack trace
    const parsedStack = stackUtils.parse(error.stack);
    console.log('Parsed Stack:', parsedStack);

    // Capture call site
    const callSite = stackUtils.capture(triggerError);
    console.log('Call Site:', callSite);

    // Detect error origin
    const errorOrigin = stackUtils.callSiteOrigin(error.stack);
    console.log('Error Origin:', errorOrigin);
  }

By integrating Stack Utils into your JavaScript application, you can manage error handling and stack traces more effectively, leading to easier debugging and more robust code.

---

Hash: 447988c5a2d3f1e168d1945980bfe5d0f4f81a8bd9341ba716b88f23a8c45502