sindresorhus / caller-path

Get the path of the caller module

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.}

caller-path's Issues

Tests are failing on Node >= 0.12

@sindresorhus
See the build status. Same thing is also happening upstream.

Missing license files

@sindresorhus Hi Sindre, thank you for this package. Would you mind adding the license file to the npm package of v0.1.0 and latest? Without it we're not really able to use it, because it makes the npm package a distribution of proprietary code.

Additionally I noticed the license file does not include the date, which makes it invalid. I'd greatly appreciate it if you could add the dates to the license files in GH repo as well.

Many thanks for your consideration.

Integer as caller depth argument?

Hi @sindresorhus!

Awesome package, I am using it in save-file and in upcoming audio release.

Unfortunately it turns out that oftentimes we need not the caller path, but caller's caller path.
For example, I expect path to be the invocator's path, not the saveAs path:

//test/index.js

const saveAs = require('save-file')

//so I expect the file to be placed into `test` directory
//but caller-path inside `saveAs` returns `saveAs` path `.../node_modules/save-file/index.js`
saveAs(buf, 'my-record.wav')

What I do now is use callsites directly here:

var callerPath = callsites()[1].getFileName()

What I'd suggest is passing an id of the caller for that purpose:

var cpath = callerPath(1)

That would not break the current behaviour and at the same time would allow to specify caller.
If you need a PR I can come up with one.

Thank you for your time, sincerely,

---

IssueHunt Summary

yaodingyd has been rewarded.

Backers (Total: $40.00)

• issuehunt ($40.00)

Submitted pull Requests

• #6 Add depth option

---

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

---

IssueHunt has been backed by the following sponsors. Become a sponsor

"Must use import to load ES Module" after updating to v4

Must use import to load ES Module: /home/runner/work/integrify/integrify/node_modules/caller-path/index.js
require() of ES modules is not supported.
require() of /home/runner/work/integrify/integrify/node_modules/caller-path/index.js from /home/runner/work/integrify/integrify/lib/index.js is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename /home/runner/work/integrify/integrify/node_modules/caller-path/index.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /home/runner/work/integrify/integrify/node_modules/caller-path/package.json.

No idea how to fix this.

See: https://github.com/anishkny/integrify/pull/89/checks?check_run_id=3844631811#step:5:100

TypeError: Cannot read property 'getFileName' of undefined

node 4.x

I have /home/user/dev/project/client/jsx/__tests__/require-clean.js

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

function requireClean(smthPath) {
    const calledFrom = callerPath();

    console.log(calledFrom);
    //...
}

module.exports = requireClean;

I use it in /home/user/dev/project/client/jsx/applications/edit/__tests__/application.action.test.js

const requireClean = require('../../../__tests__/require-clean');

describe('Some tests: ', () => {
    beforeEach(function () {
        requireClean('../../../smth');
    });
    //...
});

I must get in console:

/home/user/dev/project/client/jsx/applications/edit/__tests__/application.action.test.js

but I get the error:

TypeError: Cannot read property 'getFileName' of undefined

See caller module. It works correct in the same situation

Node 10: Cannot read property 'getFileName' of undefined

As evidenced by its type definitions, the caller-callsite package is expected to return undefined in some cases, but this package does not handle that edge case. See the following CI logs for proof.

https://github.com/alloc/indo/runs/2336481322?check_suite_focus=true#step:5:15

Version

• [email protected]