grouped-accessor-pairs
Require grouped accessor pairs in object literals and classes
A getter and setter for the same property don’t necessarily have to be defined adjacent to each other.
For example, the following statements would create the same object:
var o = {
get a() {
return this.val;
},
set a(value) {
this.val = value;
},
b: 1
};
var o = {
get a() {
return this.val;
},
b: 1,
set a(value) {
this.val = value;
}
};
While it is allowed to define the pair for a getter or a setter anywhere in an object or class definition, it’s considered a best practice to group accessor functions for the same property.
In other words, if a property has a getter and a setter, the setter should be defined right after the getter, or vice versa.
Rule Details
This rule requires grouped definitions of accessor functions for the same property in object literals, class declarations and class expressions.
Optionally, this rule can also enforce consistent order (getBeforeSet or setBeforeGet).
This rule does not enforce the existence of the pair for a getter or a setter. See accessor-pairs if you also want to enforce getter/setter pairs.
Examples of incorrect code for this rule:
Open in Playground
/*eslint grouped-accessor-pairs: "error"*/
var foo = {
get a() {
return this.val;
},
b: 1,
(value) {
this.val = value;
}
};
var bar = {
set b(value) {
this.val = value;
},
a: 1,
() {
return this.val;
}
}
class Foo {
set a(value) {
this.val = value;
}
b(){}
() {
return this.val;
}
}
const Bar = class {
static get a() {
return this.val;
}
b(){}
(value) {
this.val = value;
}
}
Examples of correct code for this rule:
Open in Playground
/*eslint grouped-accessor-pairs: "error"*/
var foo = {
get a() {
return this.val;
},
set a(value) {
this.val = value;
},
b: 1
};
var bar = {
set b(value) {
this.val = value;
},
get b() {
return this.val;
},
a: 1
}
class Foo {
set a(value) {
this.val = value;
}
get a() {
return this.val;
}
b(){}
}
const Bar = class {
static get a() {
return this.val;
}
static set a(value) {
this.val = value;
}
b(){}
}
Options
This rule has a string option:
"anyOrder"(default) does not enforce order."getBeforeSet"if a property has both getter and setter, requires the getter to be defined before the setter."setBeforeGet"if a property has both getter and setter, requires the setter to be defined before the getter.
getBeforeSet
Examples of incorrect code for this rule with the "getBeforeSet" option:
Open in Playground
/*eslint grouped-accessor-pairs: ["error", "getBeforeSet"]*/
var foo = {
set a(value) {
this.val = value;
},
() {
return this.val;
}
};
class Foo {
set a(value) {
this.val = value;
}
() {
return this.val;
}
}
const Bar = class {
static set a(value) {
this.val = value;
}
() {
return this.val;
}
}
Examples of correct code for this rule with the "getBeforeSet" option:
Open in Playground
/*eslint grouped-accessor-pairs: ["error", "getBeforeSet"]*/
var foo = {
get a() {
return this.val;
},
set a(value) {
this.val = value;
}
};
class Foo {
get a() {
return this.val;
}
set a(value) {
this.val = value;
}
}
const Bar = class {
static get a() {
return this.val;
}
static set a(value) {
this.val = value;
}
}
setBeforeGet
Examples of incorrect code for this rule with the "setBeforeGet" option:
Open in Playground
/*eslint grouped-accessor-pairs: ["error", "setBeforeGet"]*/
var foo = {
get a() {
return this.val;
},
(value) {
this.val = value;
}
};
class Foo {
get a() {
return this.val;
}
(value) {
this.val = value;
}
}
const Bar = class {
static get a() {
return this.val;
}
(value) {
this.val = value;
}
}
Examples of correct code for this rule with the "setBeforeGet" option:
Open in Playground
/*eslint grouped-accessor-pairs: ["error", "setBeforeGet"]*/
var foo = {
set a(value) {
this.val = value;
},
get a() {
return this.val;
}
};
class Foo {
set a(value) {
this.val = value;
}
get a() {
return this.val;
}
}
const Bar = class {
static set a(value) {
this.val = value;
}
static get a() {
return this.val;
}
}
Known Limitations
Due to the limits of static analysis, this rule does not account for possible side effects and in certain cases might require or miss to require grouping or order for getters/setters that have a computed key, like in the following example:
/*eslint grouped-accessor-pairs: "error"*/
var a = 1;
// false warning (false positive)
var foo = {
get [a++]() {
return this.val;
},
b: 1,
set [a++](value) {
this.val = value;
}
};
// missed warning (false negative)
var bar = {
get [++a]() {
return this.val;
},
b: 1,
set [a](value) {
this.val = value;
}
};
Also, this rule does not report any warnings for properties that have duplicate getters or setters.
See no-dupe-keys if you also want to disallow duplicate keys in object literals.
See no-dupe-class-members if you also want to disallow duplicate names in class definitions.
Related Rules
Version
This rule was introduced in ESLint v6.7.0.
Further Reading