aboutsummaryrefslogtreecommitdiff
path: root/node_modules/callsites/readme.md
diff options
context:
space:
mode:
authorJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
committerJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
commit080c5819d87b933816d724a83f3bf4f1686770a7 (patch)
tree4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/callsites/readme.md
parent5ac7049a9d30733165cc212dee308163c2a14644 (diff)
parentd003b82235a9329f912522a2f70aa950dfce4998 (diff)
downloadLYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz
LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/callsites/readme.md')
-rw-r--r--node_modules/callsites/readme.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/node_modules/callsites/readme.md b/node_modules/callsites/readme.md
new file mode 100644
index 0000000..fc84613
--- /dev/null
+++ b/node_modules/callsites/readme.md
@@ -0,0 +1,48 @@
+# callsites [![Build Status](https://travis-ci.org/sindresorhus/callsites.svg?branch=master)](https://travis-ci.org/sindresorhus/callsites)
+
+> Get callsites from the [V8 stack trace API](https://v8.dev/docs/stack-trace-api)
+
+
+## Install
+
+```
+$ npm install callsites
+```
+
+
+## Usage
+
+```js
+const callsites = require('callsites');
+
+function unicorn() {
+ console.log(callsites()[0].getFileName());
+ //=> '/Users/sindresorhus/dev/callsites/test.js'
+}
+
+unicorn();
+```
+
+
+## API
+
+Returns an array of callsite objects with the following methods:
+
+- `getThis`: returns the value of `this`.
+- `getTypeName`: returns the type of `this` as a string. This is the name of the function stored in the constructor field of `this`, if available, otherwise the object's `[[Class]]` internal property.
+- `getFunction`: returns the current function.
+- `getFunctionName`: returns the name of the current function, typically its `name` property. If a name property is not available an attempt will be made to try to infer a name from the function's context.
+- `getMethodName`: returns the name of the property of `this` or one of its prototypes that holds the current function.
+- `getFileName`: if this function was defined in a script returns the name of the script.
+- `getLineNumber`: if this function was defined in a script returns the current line number.
+- `getColumnNumber`: if this function was defined in a script returns the current column number
+- `getEvalOrigin`: if this function was created using a call to `eval` returns a string representing the location where `eval` was called.
+- `isToplevel`: is this a top-level invocation, that is, is this the global object?
+- `isEval`: does this call take place in code defined by a call to `eval`?
+- `isNative`: is this call in native V8 code?
+- `isConstructor`: is this a constructor call?
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)