mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-30 08:09:15 +01:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
23 lines
517 B
JavaScript
23 lines
517 B
JavaScript
/**
|
|
* Returns error without stack trace for better UI display
|
|
* @param {Error} err - error
|
|
* @returns {Error} Error with clean stack trace.
|
|
*/
|
|
export default function cleanErrorStack(err) {
|
|
let { name } = err
|
|
name = name === undefined ? 'Error' : String(name)
|
|
|
|
let msg = err.message
|
|
msg = msg === undefined ? '' : String(msg)
|
|
|
|
if (name === '') {
|
|
err.stack = err.message
|
|
} else if (msg === '') {
|
|
err.stack = err.name
|
|
} else {
|
|
err.stack = `${err.name}: ${err.message}`
|
|
}
|
|
|
|
return err
|
|
}
|