catch-error-name.md

catch-error-name

📝 Enforce a specific parameter name in catch clauses.

💼🚫 This rule is enabled in the ✅ recommended config. This rule is disabled in the ☑️ unopinionated config.

🔧 This rule is automatically fixable by the --fix CLI option.

Applies to

• try/catch clauses handlers
• promise.catch(…) handlers
• promise.then(onFulfilled, …) handlers

The desired name is configurable, but defaults to error.

The following names are ignored:

• _, but only if the error is not used.
• Descriptive names, for example, fsError or authError.
• Names matching options.ignore.

Examples

// ❌
try {} catch (badName) {}

// ✅
try {} catch (error) {}

// ❌
promise.catch(badName => {});

// ✅
promise.catch(error => {});

// ❌
promise.then(undefined, badName => {});

// ✅
promise.then(undefined, error => {});

// ❌
try {} catch (_) {
	console.log(_);
}

// ✅
try {} catch (_) {
	console.log(foo);
}

// ✅
// Descriptive name is allowed
try {} catch (fsError) {}

// ✅
// `error_` is allowed because of shadowed variables
try {} catch (error_) {
	const error = new Error('🦄');
}

Options

name

Type: string
Default: 'error'

You can set the name option like this:

"unicorn/catch-error-name": [
	"error",
	{
		"name": "exception"
	}
]

ignore

Type: Array<string | RegExp>
Default: []

This option lets you specify a regex pattern for matches to ignore.

When a string is given, it's interpreted as a regular expressions inside a string. Needed for ESLint config in JSON.

"unicorn/catch-error-name": [
	"error",
	{
		"ignore": [
			"^error\\d*$",
			/^ignore/i
		]
	}
]

With ^unicorn$, this would fail:

try {} catch (pony) {}

And this would pass:

try {} catch (unicorn) {}

Tip

In order to avoid shadowing in nested catch clauses, the auto-fix rule appends underscores to the identifier name.