Sha256: 875c685ffc4c32f32cf4cdd78474127facfb63eb72926a263b8d39174cac1af8

Contents?: true

Size: 1.15 KB

Versions: 50

Compression:

Stored size: 1.15 KB

Contents

declare namespace cleanStack {
	interface Options {
		/**
		Prettify the file paths in the stack:

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

		@default false
		*/
		readonly pretty?: boolean;
	}
}

/**
Clean up error stack traces. Removes the mostly unhelpful internal Node.js entries.

@param stack - The `stack` property of an `Error`.

@example
```
import cleanStack = require('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)
```
*/
declare function cleanStack(
	stack: string,
	options?: cleanStack.Options
): string;

export = cleanStack;

Version data entries

50 entries across 49 versions & 7 rubygems

Version Path
immosquare-cleaner-0.1.60 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.59 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.58 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.57 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.56 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.55 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.54 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.53 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.52 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.51 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.50 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.49 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.48 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.47 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.46 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.45 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.44 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.43 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.42 node_modules/clean-stack/index.d.ts
immosquare-cleaner-0.1.41 node_modules/clean-stack/index.d.ts