func-style

Enforce the consistent use of either function declarations or expressions assigned to variables

There are two ways of defining functions in JavaScript: function declarations and function expressions assigned to variables. Function declarations are statements that begin with the function keyword. Function expressions can either be arrow functions or use the function keyword with an optional name. Here are some examples:

// function declaration
function doSomething() {
    // ...
}

// arrow function expression assigned to a variable
const doSomethingElse = () => {
    // ...
};

// function expression assigned to a variable
const doSomethingAgain = function() {
    // ...
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14

The primary difference between function declarations and function expressions is that declarations are hoisted to the top of the scope in which they are defined, which allows you to write code that uses the function before its declaration. For example:

doSomething(); // ok

function doSomething() {
    // ...
}
1
2
3
4
5

For function expressions, you must define the function before it is used, otherwise it causes an error. Example:

doSomething();  // error!

var doSomething = function() {
    // ...
};
1
2
3
4
5

In this case, doSomething is undefined at the time of invocation and so causes a runtime error.

Due to these different behaviors, it is common to have guidelines as to which style of function should be used. There is really no correct or incorrect choice here, it is just a preference.

Rule Details

This rule enforces a particular type of function style, either function declarations or expressions assigned to variables. You can specify which you prefer in the configuration.

Note: This rule does not apply to all functions. For example, a callback function passed as an argument to another function is not considered by this rule.

Options

This rule has a string option:

• "expression" (default) requires the use of function expressions instead of function declarations
• "declaration" requires the use of function declarations instead of function expressions

This rule has an object option for two exceptions:

• "allowArrowFunctions": true (default false) allows the use of arrow functions. This option applies only when the string option is set to "declaration" (arrow functions are always allowed when the string option is set to "expression", regardless of this option)
• "overrides":
  • "namedExports": "expression" | "declaration" | "ignore": used to override function styles in named exports
    • "expression": like string option
    • "declaration": like string option
    • "ignore": either style is acceptable

expression

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

/*eslint func-style: ["error", "expression"]*/

function foo() {
    // ...
}
1
2
3
4
5

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

/*eslint func-style: ["error", "expression"]*/

var foo = function() {
    // ...
};

var foo = () => {};

// allowed as allowArrowFunctions : false is applied only for declaration
1
2
3
4
5
6
7
8
9

declaration

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

/*eslint func-style: ["error", "declaration"]*/

var foo = function() {
    // ...
};

var foo = () => {};
1
2
3
4
5
6
7

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

/*eslint func-style: ["error", "declaration"]*/

function foo() {
    // ...
}

// Methods (functions assigned to objects) are not checked by this rule
SomeObject.foo = function() {
    // ...
};
1
2
3
4
5
6
7
8
9
10

allowArrowFunctions

Examples of additional correct code for this rule with the "declaration", { "allowArrowFunctions": true } options:

/*eslint func-style: ["error", "declaration", { "allowArrowFunctions": true }]*/

var foo = () => {};
1
2
3

overrides

namedExports

expression

Examples of incorrect code for this rule with the "declaration" and {"overrides": { "namedExports": "expression" }} option:

/*eslint func-style: ["error", "declaration", { "overrides": { "namedExports": "expression" } }]*/

export function foo() {
    // ...
}
1
2
3
4
5

Examples of correct code for this rule with the "declaration" and {"overrides": { "namedExports": "expression" }} option:

/*eslint func-style: ["error", "declaration", { "overrides": { "namedExports": "expression" } }]*/

export var foo = function() {
    // ...
};

export var bar = () => {};
1
2
3
4
5
6
7

declaration

Examples of incorrect code for this rule with the "expression" and {"overrides": { "namedExports": "declaration" }} option:

/*eslint func-style: ["error", "expression", { "overrides": { "namedExports": "declaration" } }]*/

export var foo = function() {
    // ...
};

export var bar = () => {};
1
2
3
4
5
6
7

Examples of correct code for this rule with the "expression" and {"overrides": { "namedExports": "declaration" }} option:

/*eslint func-style: ["error", "expression", { "overrides": { "namedExports": "declaration" } }]*/

export function foo() {
    // ...
}
1
2
3
4
5

ignore

Examples of correct code for this rule with the {"overrides": { "namedExports": "ignore" }} option:

/*eslint func-style: ["error", "expression", { "overrides": { "namedExports": "ignore" } }]*/

export var foo = function() {
    // ...
};

export var bar = () => {};

export function baz() {
    // ...
}
1
2
3
4
5
6
7
8
9
10
11

When Not To Use It

If you want to allow developers to each decide how they want to write functions on their own, then you can disable this rule.

Version

This rule was introduced in ESLint v0.2.0.

Further Reading

JavaScript Scoping and Hoisting
www.adequatelygood.com

Resources

• Rule source
• Tests source