Dia antes primera install
This commit is contained in:
86
node_modules/inspect-function/README.md
generated
vendored
Normal file
86
node_modules/inspect-function/README.md
generated
vendored
Normal file
@@ -0,0 +1,86 @@
|
||||
# inspect-function
|
||||
|
||||
[](https://travis-ci.org/DiegoZoracKy/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
|
||||
|
||||
```bash
|
||||
npm install inspect-function
|
||||
```
|
||||
**CLI**
|
||||
```bash
|
||||
npm install inspect-function -g
|
||||
```
|
||||
```bash
|
||||
npx inspect-function --help
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
`inspectFunction(fn, name);`
|
||||
|
||||
```javascript
|
||||
// The module
|
||||
const inspectFunction = require('inspect-function');
|
||||
|
||||
// A function
|
||||
const testFunction = (a = 'z', b = [1,2,3], c, {d,e: {f}, g} = {}) => console.log('noop');
|
||||
|
||||
// Inspects
|
||||
const result = inspectFunction(testFunction);
|
||||
|
||||
////////////////////////
|
||||
// `result` will be: //
|
||||
////////////////////////
|
||||
{
|
||||
"name": "testFunction",
|
||||
"signature": "testFunction(a = 'z', b = [1,2,3], c, {d,e: {f}, g} = {});",
|
||||
"parameters": [
|
||||
{
|
||||
"parameter": "a",
|
||||
"defaultValue": "z",
|
||||
"declaration": "a = 'z'"
|
||||
},
|
||||
{
|
||||
"parameter": "b",
|
||||
"defaultValue": "[1,2,3]",
|
||||
"declaration": "b = [1,2,3]"
|
||||
},
|
||||
{
|
||||
"parameter": "c",
|
||||
"declaration": "c"
|
||||
},
|
||||
{
|
||||
"parameter": "{d,e: {f}, g}",
|
||||
"defaultValue": "{}",
|
||||
"expectsDestructuring": true,
|
||||
"declaration": "{d,e: {f}, g} = {}",
|
||||
"destructuredParameters": [
|
||||
{
|
||||
"parameter": "d",
|
||||
"declaration": "d"
|
||||
},
|
||||
{
|
||||
"parameter": "f",
|
||||
"declaration": "f"
|
||||
},
|
||||
{
|
||||
"parameter": "g",
|
||||
"declaration": "g"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"parametersNames": [
|
||||
"a",
|
||||
"b",
|
||||
"c",
|
||||
"d",
|
||||
"f",
|
||||
"g"
|
||||
]
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user