diff options
| author | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 23:08:57 +0300 |
|---|---|---|
| committer | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 23:08:57 +0300 |
| commit | 726b81b19251674e149ccfbb1abacbd837fc6db0 (patch) | |
| tree | fbdbb227dc01357eb76e8222d76185bc124c5ca6 /node_modules/flora-colossus/README.md | |
| parent | 34f0890e175698940d49238097579f44e4d78c89 (diff) | |
| download | FlashRunner-726b81b19251674e149ccfbb1abacbd837fc6db0.tar.gz FlashRunner-726b81b19251674e149ccfbb1abacbd837fc6db0.tar.zst | |
Removed files that should not have been included in git
Diffstat (limited to 'node_modules/flora-colossus/README.md')
| -rw-r--r-- | node_modules/flora-colossus/README.md | 43 |
1 files changed, 0 insertions, 43 deletions
diff --git a/node_modules/flora-colossus/README.md b/node_modules/flora-colossus/README.md deleted file mode 100644 index 074dc60..0000000 --- a/node_modules/flora-colossus/README.md +++ /dev/null @@ -1,43 +0,0 @@ -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 |