Big news!Introducing Socket AI - ChatGPT-Powered Threat Analysis.Learn more
Socket
Socket

clean-stack

Package Overview
Dependencies
1
Maintainers
1
Versions
20
Issues
File Explorer

Advanced tools

clean-stack

Clean up error stack traces

    5.2.0latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
23,389,243
increased by1.16%

Weekly downloads

Readme

Source

clean-stack

Clean up error stack traces

Removes the mostly unhelpful internal Node.js entries.

Also works in Electron.

Install

npm install clean-stack

Usage

import cleanStack from 'clean-stack'; const error = new Error('Missing unicorn'); console.log(error.stack); /* Error: Missing unicorn at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15) at Module._compile (module.js:409:26) at Object.Module._extensions..js (module.js:416:10) at Module.load (module.js:343:32) at Function.Module._load (module.js:300:12) at Function.Module.runMain (module.js:441:10) at startup (node.js:139:18) */ console.log(cleanStack(error.stack)); /* Error: Missing unicorn at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15) */

API

cleanStack(stack, options?)

Returns the cleaned stack or undefined if the given stack is undefined.

stack

Type: string | undefined

The stack property of an Error.

options

Type: object

pretty

Type: boolean
Default: false

Prettify the file paths in the stack:

/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15~/dev/clean-stack/unicorn.js:2:15

basePath

Type: string?

Remove the given base path from stack trace file paths, effectively turning absolute paths into relative ones. It will also transform absolute file URLs into relative paths.

Example with '/Users/sindresorhus/dev/clean-stack' as basePath:

/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15unicorn.js:2:15

pathFilter

Type: (path: string) => boolean

Remove the stack lines where the given function returns false. The function receives the path part of the stack line.

import cleanStack from 'clean-stack'; const error = new Error('Missing unicorn'); console.log(cleanStack(error.stack)); // Error: Missing unicorn // at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15) // at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/omit-me.js:1:16) const pathFilter = path => !/omit-me/.test(path); console.log(cleanStack(error.stack, {pathFilter})); // Error: Missing unicorn // at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
  • extract-stack - Extract the actual stack of an error
  • stack-utils - Captures and cleans stack traces

Keywords

FAQs

Last updated on 21 Mar 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
Socket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc