mirror of
https://github.com/S2-/gitlit
synced 2025-08-03 21:00:04 +02:00
add node modules to repo
This commit is contained in:
84
app/node_modules/flora-colossus/README.md
generated
vendored
84
app/node_modules/flora-colossus/README.md
generated
vendored
@@ -1,43 +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
|
||||
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.
|
Reference in New Issue
Block a user