kibana/api_docs/kbn_find_used_node_modules.devdocs.json
2022-09-08 14:08:29 +09:30

63 lines
No EOL
2.6 KiB
JSON

{
"id": "@kbn/find-used-node-modules",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/find-used-node-modules",
"id": "def-server.findUsedNodeModules",
"type": "Function",
"tags": [],
"label": "findUsedNodeModules",
"description": [
"\nParse a list of entry paths and find the node_modules which are required by them. If the\nentry path requires/imports a non-node_module then that file is scanned too, deeply, until\nall referenced files are scanned.\n\nOptionally, we can find the used peers of the used node_modules. This will keep track of all\nthe paths we use to enter a node_module and then traverse from those points, finding the\nused modules and comparing those to the `peerDependencies` listed in the node_module's package.json\nfile. If a used dependeny is in the `peerDependencies` and is used by the node_module it will\nbe included in the results.\n\nThis was implemented mostly for `@emotion/react` which is used by @elastic/eui but only listed\nas a peerDependency. If we didn't keep it in the Kibana package.json then the package would not\nbe installed and cause an error on startup because `@emotion/react` can't be found. We used to\nsolve this by scanning the node_modules directory for all the packages which are used but that\nwas much slower and lead to extra entries in package.json."
],
"signature": [
"(options: Options) => Promise<string[]>"
],
"path": "packages/kbn-find-used-node-modules/src/find_used_node_modules.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/find-used-node-modules",
"id": "def-server.findUsedNodeModules.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Options"
],
"path": "packages/kbn-find-used-node-modules/src/find_used_node_modules.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}