diff options
| author | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
|---|---|---|
| committer | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
| commit | 703e03aba33f234712206769f57717ba7d92d23d (patch) | |
| tree | 0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/galactus/README.md | |
| parent | ab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff) | |
| download | FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst | |
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/galactus/README.md')
| -rw-r--r-- | node_modules/galactus/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/node_modules/galactus/README.md b/node_modules/galactus/README.md new file mode 100644 index 0000000..0f95c69 --- /dev/null +++ b/node_modules/galactus/README.md @@ -0,0 +1,46 @@ +Galactus
+-----------
+
+> A JS implementation of `prune --production`
+
+## Installation
+
+```bash
+npm i --save-dev galactus
+```
+
+## API
+
+### Class: `DestroyerOfModules`
+
+```js
+import { DestroyerOfModules } from 'galactus';
+
+// modulePath is the root folder of your module
+const destroyer = new DestroyerOfModules({
+ rootDirectory: __dirname,
+ // Optionally provide your own walker from 'flora-colossus'
+ walker: myWalker,
+ // Optionally provide a method to override the default
+ // keep or destroy test
+ shouldKeepModuleTest: (module, isDepDep) => true,
+});
+```
+
+#### `destroyer.destroy()`
+
+Returns a `Promise` that resolves once the destruction is complete. By default
+it will destroy all dependencies that aren't required for production or
+optional dependencies. You can override this behavior by providing a
+`shouldKeepModuleTest` function in the constructor.
+
+#### `destroyer.collectKeptModules()`
+
+Returns a `Promise` of a `ModuleMap` (a `Map` of paths to `Module`s). The
+`Promise` resolves when the walker finishes walking the module tree. The
+`ModuleMap` only contains the `Module`s that would be kept by a call
+to `destroy()`.
+
+There is one optional keyword argument, `relativePaths`. By default, the paths
+in the `ModuleMap` are absolute. If `relativePaths` is `true`, they are relative
+to the `rootDirectory` specified in the constructor.
|