docs/src/rules/yield-star-spacing.md
This rule enforces spacing around the * in yield* expressions.
The rule takes one option, an object, which has two keys before and after having boolean values true or false.
before enforces spacing between the yield and the *.
If true, a space is required, otherwise spaces are disallowed.
after enforces spacing between the * and the argument.
If it is true, a space is required, otherwise spaces are disallowed.
The default is {"before": false, "after": true}.
"yield-star-spacing": ["error", {"before": true, "after": false}]
The option also has a string shorthand:
{"before": false, "after": true} → "after"{"before": true, "after": false} → "before"{"before": true, "after": true} → "both"{"before": false, "after": false} → "neither""yield-star-spacing": ["error", "after"]
Examples of correct code for this rule with the default "after" option:
::: correct
/*eslint yield-star-spacing: ["error", "after"]*/
function* generator() {
yield* other();
}
:::
Examples of correct code for this rule with the "before" option:
::: correct
/*eslint yield-star-spacing: ["error", "before"]*/
function *generator() {
yield *other();
}
:::
Examples of correct code for this rule with the "both" option:
::: correct
/*eslint yield-star-spacing: ["error", "both"]*/
function * generator() {
yield * other();
}
:::
Examples of correct code for this rule with the "neither" option:
::: correct
/*eslint yield-star-spacing: ["error", "neither"]*/
function*generator() {
yield*other();
}
:::
If your project will not be using generators or you are not concerned with spacing consistency, you do not need this rule.