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();

Current Tags

• 4.0.0                                ...           latest (3 years ago)

6 Versions

• 4.0.0                                ...           3 years ago
• 3.0.1                                ...           4 years ago
• 3.0.0                                ...           5 years ago
• 2.0.0                                ...           8 years ago
• 1.0.0                                ...           10 years ago
• 0.1.0                                ...           11 years ago