Name: function-scout
Owner: NodeSource
Description: Scouts all functions of a given object and provides data about their origin.
Created: 2017-02-10 16:54:15.0
Updated: 2017-05-21 03:13:50.0
Pushed: 2017-10-26 15:41:15.0
Homepage: https://github.com/thlorenz/function-scout
Size: 1187
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Scouts all functions of a given object and provides data about their origin.
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)
s
outed:
nctionOrigin {
file: 'path.js',
line: 1354,
column: 29,
inferredName: '',
name: 'basename' },
nctions:
{ path: [],
key: undefined,
level: 0,
info:
FunctionOrigin {
file: 'path.js',
line: 1354,
column: 29,
inferredName: '',
name: 'basename' } } ] }
Also see the full fs.createReadStream
example
npm install function-scout
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 the object which functions to scout$0
Object configure how functions are scouted$0.mutate
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? 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 with properties scouted
(if mutate=true
) and
functions
explained above
MIT