caller-path

What is caller-path?

The caller-path npm package is designed to help developers retrieve the path of the file that calls a function. This can be particularly useful for debugging, logging, and tracking the flow of a program, especially in complex applications where functions are called from multiple places.

What are caller-path's main functionalities?

Get caller file path

This feature allows developers to log or retrieve the path of the file that called a function. In the provided code, the function `whoCalled` uses `callerPath()` to print the path of the caller file.

const callerPath = require('caller-path');

function whoCalled() {
  console.log(callerPath());
}

module.exports = whoCalled;

Other packages similar to caller-path

callsites

The 'callsites' package provides functionality to get the call sites (stack frames) of the V8 stack trace API, which can be used to find the path of the caller. It offers more detailed control over the stack trace compared to caller-path, allowing developers to access deeper insights into the call stack.

stack-trace

This package is used to extract a stack trace from within a running node.js application, similar to caller-path. It differs in that it provides a more comprehensive set of features for manipulating and analyzing the stack trace beyond just retrieving the caller's path.

README

caller-path

Get the path of the caller function

Install

npm install caller-path

Usage

// foo.js
import callerPath from 'caller-path';

export default function foo() {
	console.log(callerPath());
	//=> '/Users/sindresorhus/dev/unicorn/bar.js'
}

// bar.js
import foo from './foo.js';
foo();

If the caller's callsite object getFileName was not defined for some reason, it will return undefined.

API

callerPath(options?)

Get the path of the caller function.

depth

Type: number
Default: 0

The caller path depth, meaning how many levels we follow back on the stack trace.

For example:

// foo.js
import callerPath from 'caller-path';

export default function foo() {
	console.log(callerPath());
	//=> '/Users/sindresorhus/dev/unicorn/foobar.js'
	console.log(callerPath({depth: 1}));
	//=> '/Users/sindresorhus/dev/unicorn/bar.js'
	console.log(callerPath({depth: 2}));
	//=> '/Users/sindresorhus/dev/unicorn/foo.js'
}

// bar.js
import foo from './foo.js';

export default function bar() {
	foo();
}

// foobar.js
import bar from './bar.js';
bar();

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}