• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..20-Sep-2020-

LICENSE.mdH A D26-Oct-1985745 74

README.mdH A D26-Oct-19851 KiB4226

index.d.tsH A D26-Oct-198571 32

index.js.mapH A D26-Oct-1985773 11

package.jsonH A D20-Sep-20202.1 KiB6968

README.md

1# get-caller-file
2
3[![Build Status](https://travis-ci.org/stefanpenner/get-caller-file.svg?branch=master)](https://travis-ci.org/stefanpenner/get-caller-file)
4[![Build status](https://ci.appveyor.com/api/projects/status/ol2q94g1932cy14a/branch/master?svg=true)](https://ci.appveyor.com/project/embercli/get-caller-file/branch/master)
5
6This is a utility, which allows a function to figure out from which file it was invoked. It does so by inspecting v8's stack trace at the time it is invoked.
7
8Inspired by http://stackoverflow.com/questions/13227489
9
10*note: this relies on Node/V8 specific APIs, as such other runtimes may not work*
11
12## Installation
13
14```bash
15yarn add get-caller-file
16```
17
18## Usage
19
20Given:
21
22```js
23// ./foo.js
24const getCallerFile = require('get-caller-file');
25
26module.exports = function() {
27  return getCallerFile(); // figures out who called it
28};
29```
30
31```js
32// index.js
33const foo = require('./foo');
34
35foo() // => /full/path/to/this/file/index.js
36```
37
38
39## Options:
40
41* `getCallerFile(position = 2)`: where position is stack frame whos fileName we want.
42