summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/callsites/readme.md
diff options
context:
space:
mode:
authorMichaël Zasso <targos@protonmail.com>2017-12-22 16:53:42 +0100
committerMichaël Zasso <targos@protonmail.com>2018-01-11 09:48:05 +0100
commit3dc30632755713179f345f4af024bd904c6162d0 (patch)
treef28c4f6dd6dfc5992edf301449d1a371d229755b /tools/node_modules/eslint/node_modules/callsites/readme.md
parenta2c7085dd4a8e60d1a47572aca8bb6fcb7a32f88 (diff)
downloadnode-new-3dc30632755713179f345f4af024bd904c6162d0.tar.gz
tools: move eslint from tools to tools/node_modules
This is required because we need to add the babel-eslint dependency and it has to be able to resolve "eslint". babel-eslint is required to support future ES features such as async iterators and import.meta. Refs: https://github.com/nodejs/node/pull/17755 PR-URL: https://github.com/nodejs/node/pull/17820 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Diffstat (limited to 'tools/node_modules/eslint/node_modules/callsites/readme.md')
-rw-r--r--tools/node_modules/eslint/node_modules/callsites/readme.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/callsites/readme.md b/tools/node_modules/eslint/node_modules/callsites/readme.md
new file mode 100644
index 0000000000..23aaca443a
--- /dev/null
+++ b/tools/node_modules/eslint/node_modules/callsites/readme.md
@@ -0,0 +1,47 @@
+# 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://code.google.com/p/v8/wiki/JavaScriptStackTraceApi)
+
+
+## Install
+
+```sh
+$ npm install --save callsites
+```
+
+
+## Usage
+
+```js
+var 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 CallSite object representing the location where eval was called
+- `isToplevel`: is this a toplevel 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](http://sindresorhus.com)