callsite

What is callsite?

The callsite npm package allows developers to access the call stack of V8 engines in Node.js applications. It provides a way to inspect and manipulate the call stack, which can be useful for debugging, logging, and tracking the flow of an application. The package offers a straightforward API to retrieve an array of call sites (stack frames), enabling developers to programmatically explore and utilize call stack information.

What are callsite's main functionalities?

Accessing the call stack

This feature allows developers to access the current call stack. The code sample demonstrates how to use the callsite package to retrieve the call stack within a function and then print the file name of the caller function.

const callsite = require('callsite');

function sampleFunction() {
  const stack = callsite();
  const requester = stack[1].getFileName();
  console.log(`Called by ${requester}`);
}

sampleFunction();

Other packages similar to callsite

stack-trace

The 'stack-trace' package provides similar functionality to 'callsite' by allowing developers to get stack traces of V8 JavaScript engines. It offers more detailed control over the stack trace, such as filtering and mapping of stack frames. Compared to 'callsite', 'stack-trace' might offer a more comprehensive API for working with stack traces.

error-stack-parser

This package is designed to parse and extract stack traces from Error objects. While 'callsite' focuses on accessing the current call stack directly, 'error-stack-parser' is more about analyzing stack traces from existing Error objects. It can be particularly useful for error handling and logging.

README

callstack

Access to v8's "raw" CallSites.

Installation

$ npm install callsite

Example

var stack = require('callsite');

foo();

function foo() {
  bar();
}

function bar() {
  baz();
}

function baz() {
  console.log();
  stack().forEach(function(site){
    console.log('  \033[36m%s\033[90m in %s:%d\033[0m'
      , site.getFunctionName() || 'anonymous'
      , site.getFileName()
      , site.getLineNumber());
  });
  console.log();
}

Why?

Because you can do weird, stupid, clever, wacky things such as:

• better-assert

License

MIT