summaryrefslogtreecommitdiff
path: root/desktop/node_modules/flora-colossus/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/node_modules/flora-colossus/README.md')
-rw-r--r--desktop/node_modules/flora-colossus/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/desktop/node_modules/flora-colossus/README.md b/desktop/node_modules/flora-colossus/README.md
new file mode 100644
index 0000000..074dc60
--- /dev/null
+++ b/desktop/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<Module[]>`
+
+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