Enforces getter/setter pairs in objects (accessor-pairs)

强制getter/setter成对出现在对象中 (accessor-pairs)

It’s a common mistake in JavaScript to create an object with just a setter for a property but never have a corresponding getter defined for it. Without a getter, you cannot read the property, so it ends up not being used.

创建一个对象，其某个属性只有 setter 而没有对应的 getter，这在 Javascript 中是个常犯的错误。没有 getter ，你不能读取这个属性，该属性也就不会被用到。（译者注： Javascript 中不一定非要同时指定 getter 和 setter ，原文将此表述为”错误”并非是指语法上的错误）

Here are some examples:

例如：

// Bad
var o = {
    set a(value) {
        this.val = value;
    }
};

// Good
var o = {
    set a(value) {
        this.val = value;
    },
    get a() {
        return this.val;
    }
};

This rule warns if setters are defined without getters. Using an option getWithoutSet, it will warn if you have a getter without a setter also.

如果只定义 setter 而没有定义 getter，该规则会发出警告。设置了 getWithoutSet 选项，如果只有 getter 而没有 setter，该规则同样会发出警告。

Rule Details

This rule enforces a style where it requires to have a getter for every property which has a setter defined.

该规则强制一种编码风格：对于每个属性，如果定义了setter，也必须定义相应的 getter。

By activating the option getWithoutSet it enforces the presence of a setter for every property which has a getter defined.

通过激活 getWithoutSet 选项，强制为每个定义了 getter 的属性提供对应的 setter。

Options

setWithoutGet set to true will warn for setters without getters (Default true).
当 setWithoutGet 设置为true时，如果只定义 setter 而不定义 getter，该规则将发出警告（默认为 true）。
getWithoutSet set to true will warn for getters without setters (Default false).
当 getWithoutSet 设置为true时，如果只定义 getter 而不定义 setter，该规则将发出警告（默认为 false）。

setWithoutGet

Examples of incorrect code for the default { "setWithoutGet": true } option:

默认选项{ "setWithoutGet": true }的错误代码示例：

/*eslint accessor-pairs: "error"*/

var o = {
    set a(value) {
        this.val = value;
    }
};

var o = {d: 1};
Object.defineProperty(o, 'c', {
    set: function(value) {
        this.val = value;
    }
});

Examples of correct code for the default { "setWithoutGet": true } option:

默认选项{ "setWithoutGet": true }的正确代码示例：

/*eslint accessor-pairs: "error"*/

var o = {
    set a(value) {
        this.val = value;
    },
    get a() {
        return this.val;
    }
};

var o = {d: 1};
Object.defineProperty(o, 'c', {
    set: function(value) {
        this.val = value;
    },
    get: function() {
        return this.val;
    }
});

getWithoutSet

Examples of incorrect code for the { "getWithoutSet": true } option:

{ "getWithoutSet": true }选项的错误代码示例：

/*eslint accessor-pairs: ["error", { "getWithoutSet": true }]*/

var o = {
    set a(value) {
        this.val = value;
    }
};

var o = {
    get a() {
        return this.val;
    }
};

var o = {d: 1};
Object.defineProperty(o, 'c', {
    set: function(value) {
        this.val = value;
    }
});

var o = {d: 1};
Object.defineProperty(o, 'c', {
    get: function() {
        return this.val;
    }
});

Examples of correct code for the { "getWithoutSet": true } option:

{ "getWithoutSet": true }选项的正确代码示例：

/*eslint accessor-pairs: ["error", { "getWithoutSet": true }]*/
var o = {
    set a(value) {
        this.val = value;
    },
    get a() {
        return this.val;
    }
};

var o = {d: 1};
Object.defineProperty(o, 'c', {
    set: function(value) {
        this.val = value;
    },
    get: function() {
        return this.val;
    }
});

When Not To Use It

You can turn this rule off if you are not concerned with the simultaneous presence of setters and getters on objects.

如果你不关心对象里同时出现 setter 和 getter，你可以关闭这个规则。

Version

This rule was introduced in ESLint 0.22.0.

该规则在 ESLint 0.22.0 中被引入。