Last change
on this file since 59329aa was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago |
initial commit
|
-
Property mode
set to
100644
|
File size:
1.0 KB
|
Rev | Line | |
---|
[6a3a178] | 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 |
|
---|
| 6 | This 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 |
|
---|
| 8 | Inspired 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
|
---|
| 15 | yarn add get-caller-file
|
---|
| 16 | ```
|
---|
| 17 |
|
---|
| 18 | ## Usage
|
---|
| 19 |
|
---|
| 20 | Given:
|
---|
| 21 |
|
---|
| 22 | ```js
|
---|
| 23 | // ./foo.js
|
---|
| 24 | const getCallerFile = require('get-caller-file');
|
---|
| 25 |
|
---|
| 26 | module.exports = function() {
|
---|
| 27 | return getCallerFile(); // figures out who called it
|
---|
| 28 | };
|
---|
| 29 | ```
|
---|
| 30 |
|
---|
| 31 | ```js
|
---|
| 32 | // index.js
|
---|
| 33 | const foo = require('./foo');
|
---|
| 34 |
|
---|
| 35 | foo() // => /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.
|
---|
Note:
See
TracBrowser
for help on using the repository browser.