https://github.com/nodesource/function-scout
Scouts all functions of a given object and provides data about their origin.
https://github.com/nodesource/function-scout
Last synced: 8 months ago
JSON representation
Scouts all functions of a given object and provides data about their origin.
- Host: GitHub
- URL: https://github.com/nodesource/function-scout
- Owner: nodesource
- License: mit
- Archived: true
- Created: 2017-02-10T16:54:15.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-26T15:41:15.000Z (about 8 years ago)
- Last Synced: 2025-04-28T15:15:39.636Z (9 months ago)
- Language: JavaScript
- Homepage: https://github.com/thlorenz/function-scout
- Size: 1.13 MB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# function-scout [](http://travis-ci.org/nodesource/function-scout)
Scouts all functions of a given object and provides data about their origin.
```js
function inspect(obj, depth) {
console.error(require('util').inspect(obj, false, depth || 5, true))
}
const path = require('path')
const scout = require('function-scout')
const res = scout(path.basename, { mutate: true })
inspect(res)
```
```js
{ scouted:
FunctionOrigin {
file: 'path.js',
line: 1354,
column: 29,
inferredName: '',
name: 'basename' },
functions:
[ { path: [],
key: undefined,
level: 0,
info:
FunctionOrigin {
file: 'path.js',
line: 1354,
column: 29,
inferredName: '',
name: 'basename' } } ] }
```
Also see the full [`fs.createReadStream` example](examples/readStream.js)
## Installation
npm install function-scout
## [API](https://nodesource.github.io/function-scout)
### functionScout
Scouts all functions in the provided object by traversing it.
It returns an array of all functions found as `functions` and
the cloned object with all functions replaced with their information
as `scouted`
A `functions` value looks like this:
{ path: [ '_events', 'end', '1' ],
key: '1',
level: 3,
info:
FunctionOrigin {
file: '/Volumes/d/dev/js/async-hooks/function-scout/examples/readStream.js',
line: 10,
column: 14,
inferredName: '',
name: 'onend' } }
The `level, path` and `key` provide information about where in the object each
function was found.
The `scouted` functions look the same except they don't have any `level, path, key`
information since they are still attached to the object.
The `scouted` object only is returned if `mutate=true` and has the resolved functions
attached to the paths of the object at which they were originally found.
By default `mutate=false` and thus only `functions` are returned.
**Parameters**
- `object` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the object which functions to scout
- `$0` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** configure how functions are scouted
- `$0.mutate` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` the `object` is cloned and then
the are functions replaced with the scouted versions on the returned
`scouted` object. (optional, default `false`)
- `$0.referenceFunction` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** if `true` a reference to the function is
included with each of the function infos. Make sure to not hold on to it as it would
prevent the function and anything it closes over to be garbage collected (optional, default `false`)
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** with properties `scouted` (if `mutate=true`) and
`functions` explained above
## License
MIT