inspect-function

inspect-function

Inspects a function and returns informations about it (e.g. name, parameters names, parameters and default values, signature). Useful when creating automated tasks, e.g., docs generations.

Installation

npm install inspect-function

Usage

inspectFunction(fn, name);

// The module
const inspectFunction = require('inspect-function');

// Just a function to test
const testFunction = (a = 'z', b = [1,2,3], c) => console.log(a,b,c);

// Inspects
const result = inspectFunction(testFunction);

// If the second param, `name`, is passed in.
// This will be the value of result.name
// `result` will be:
{
	"name": "testFunction",
	"parametersDefinitions": [
		"a='z'",
		"b=[1,2,3]",
		"c"
	],
	"parameters": {
		"names": [
			"a",
			"b",
			"c"
		],
		"defaultValues": {
			"a": "'z'",
			"b": "[1,2,3]"
		}
	},
	"signature": "testFunction(a = 'z', b = [1,2,3], c);"
}