Enforce the position of the * in generators (generator-star)

Deprecation notice: This rule is deprecated and has been superseded by the generator-star-spacing rule. It will be removed in ESLint v1.0.

Generators are a new type of function in ECMAScript 6 that can return multiple values over time. These special functions are indicated by placing an * after the function keyword.

Here is an example of a generator function:

function* generator() {
    yield "44";
    yield "55";
}

This is also valid:

function *generator() {
    yield "44";
    yield "55";
}

This is valid as well:

function * generator() {
    yield "44";
    yield "55";
}

To keep a sense of consistency when using generators this rule enforces a single position for the *.

Rule Details

This rule enforces that the * is either placed next to the function keyword or the name of the function. The single option for this rule is a string specifying the placement of the asterick. For this option you may pass "start", "middle" or "end". The default is "end".

You can set the style in configuration like this:

"generator-star": [2, "start"]

When using "start" this placement will be enforced:

function* generator() {
}

When using "middle" this placement will be enforced:

function * generator() {
}

When using "end" this placement will be enforced:

function *generator() {
}

When using the expression syntax "start" will be enforced here:

var generator = function* () {
}

When using the expression syntax "middle" will be enforced here:

var generator = function * () {
}

When using the expression syntax "end" will be enforced here:

var generator = function *() {
}

When using the expression syntax this is valid for both "start" and "end":

var generator = function*() {
}

To use this rule you must set the generators flag to true in the ecmaFeatures configuration object.

Also note, that shortened object literal syntax for generators is not affected by this rule.

Enforce the position of the * in generators (generator-star)

Rule Details

When Not To Use It

Further Reading

Version

Resources