implicit-arrow-linebreak.md

title	layout	edit_link	rule_type	related_rules
implicit-arrow-linebreak	doc	https://github.com/eslint/eslint/edit/main/docs/src/rules/implicit-arrow-linebreak.md	layout	brace-style

Enforces the location of arrow function bodies with implicit returns.

An arrow function body can contain an implicit return as an expression instead of a block body. It can be useful to enforce a consistent location for the implicitly returned expression.

Rule Details

This rule aims to enforce a consistent location for an arrow function containing an implicit return.

Options

This rule accepts a string option:

• "beside" (default) disallows a newline before an arrow function body.
• "below" requires a newline before an arrow function body.

Examples of incorrect code for this rule with the default "beside" option:

::: incorrect

/* eslint implicit-arrow-linebreak: ["error", "beside"] */

(foo) =>
  bar;

(foo) =>
  (bar);

(foo) =>
  bar =>
    baz;

(foo) =>
(
  bar()
);

:::

Examples of correct code for this rule with the default "beside" option:

::: correct

/* eslint implicit-arrow-linebreak: ["error", "beside"] */

(foo) => bar;

(foo) => (bar);

(foo) => bar => baz;

(foo) => (
  bar()
);

// functions with block bodies allowed with this rule using any style
// to enforce a consistent location for this case, see the rule: `brace-style`
(foo) => {
  return bar();
}

(foo) =>
{
  return bar();
}

:::

Examples of incorrect code for this rule with the "below" option:

::: incorrect

/* eslint implicit-arrow-linebreak: ["error", "below"] */

(foo) => bar;

(foo) => (bar);

(foo) => bar => baz;

:::

Examples of correct code for this rule with the "below" option:

::: correct

/* eslint implicit-arrow-linebreak: ["error", "below"] */

(foo) =>
  bar;

(foo) =>
  (bar);

(foo) =>
  bar =>
    baz;

:::

When Not To Use It

If you're not concerned about consistent locations of implicitly returned arrow function expressions, you should not turn on this rule.

You can also disable this rule if you are using the "always" option for the arrow-body-style, since this will disable the use of implicit returns in arrow functions.