From 703e03aba33f234712206769f57717ba7d92d23d Mon Sep 17 00:00:00 2001 From: LinuxWizard42 Date: Wed, 12 Oct 2022 22:54:37 +0300 Subject: Added export_allowed file to make repository visible in cgit --- node_modules/flora-colossus/README.md | 43 +++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 node_modules/flora-colossus/README.md (limited to 'node_modules/flora-colossus/README.md') diff --git a/node_modules/flora-colossus/README.md b/node_modules/flora-colossus/README.md new file mode 100644 index 0000000..074dc60 --- /dev/null +++ b/node_modules/flora-colossus/README.md @@ -0,0 +1,43 @@ +Flora Colossus +----------- + +> Walk your node_modules tree + +## Installation + +```bash +npm i --save-dev flora-colossus +``` + +## API + +### Enum: `DepType` + +```js +import { DepType } from 'flora-colossus'; + +// DepType.PROD --> Production dependency +// DepType.OPTIONAL --> Optional dependency +// DepType.DEV --> Development dependency +// DepType.DEV_OPTIONAL --> Optional dependency of a development dependency +// DepType.ROOT --> The root module +``` + +#### + +### Class: `Walker` + +```js +import { Walker } from 'flora-colossus'; + +// modulePath is the root folder of your module +const walker = new Walker(modulePath); +``` + +#### `walker.walkTree()` + +Returns `Promise` + +Will walk your entire node_modules tree reporting back an array of "modules", each +module has a "path", "name" and "depType". See the typescript definition file +for more information. \ No newline at end of file -- cgit v1.2.3-86-g962b