@artdeco/clean-stack is used to remove internal _Node.JS_ lines from error stacks, as well as lines from specific modules.

``sh
yarn add @artdeco/clean-stack
npm i @artdeco/clean-stack
`

Table Of Contents

- Table Of Contents
- API
- cleanStack(stack, options=): string
* Config
- Copyright & License





API

The package is available by importing its default function:

`js
import cleanStack from '@artdeco/clean-stack'
`

cleanStack(
  stack: string,
  options=: !Config,
): string

- stack* string: The stack to clean.
- options !Config (optional): Additional options.

__Config__: Options for the program.


| Name | Type | Description | Default |
| -------------- | ----------------------------- | ------------------------------------------------------------- | ------------- |
| pretty | boolean | Replace the absolute path to the home directory with the ~. | false |
| ignoredModules | !Array<string> | Which modules to ignore in the path. | ［'pirates'］ |

The example below will remove unuseful internal _Node.JS_ lines from the error stack. Any other modules to ignore can be passed in the ignoreModules option.

`js
/ yarn example/ /
import cleanStack from '@artdeco/clean-stack'

const err =
Error: test
at Object. (/Users/zavr/adc/clean-stack/i2.js:1:69)
at Module._compile (module.js:652:30)
at Module._compile (/Users/zavr/adc/clean-stack/node_modules/pirates/lib/index.js:83:24)
at Module._extensions..js (module.js:663:10)
at Object.newLoader [as .js] (/Users/zavr/adc/clean-stack/node_modules/pirates/lib/index.js:88:7)
at Module.load (module.js:565:32)
at tryModuleLoad (module.js:505:12)
at Function.Module._load (module.js:497:3)
at Module.require (module.js:596:17)
at require (internal/module.js:11:18)
.trim()

const res = cleanStack(err)
`

`
Error: test
at Object. (/Users/zavr/adc/clean-stack/i2.js:1:69)
``

Copyright & License

Original work by Sindre Sorhus under MIT License.

alt="Art Deco">	© Art Deco™ 2020