1.2.1 • Published 4 years ago

@artdeco/clean-stack v1.2.1

Weekly downloads
42
License
AGPL-3.0
Repository
gitlab
Last release
4 years ago

@artdeco/clean-stack

npm version

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

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

Table Of Contents

API

The package is available by importing its default function:

import cleanStack from '@artdeco/clean-stack'

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

Remove internal Node.JS lines from the error stack traces.

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

Config: Options for the program.

NameTypeDescriptionDefault
prettybooleanReplace 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.

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

const err = `
Error: test
    at Object.<anonymous> (/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.<anonymous> (/Users/zavr/adc/clean-stack/i2.js:1:69)

Copyright & License

Original work by Sindre Sorhus under MIT License.