# accessor-pairs

在对象和类中强制执行 getter 和 setter

对在 JavaScript 中，一个常见的错误是只使用属性的 setter 来创建对象，但从来没有为它定义相应的 getter。如果没有 getter，您将无法读取该属性，因此它最终不会被使用。

这里有些例子：

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

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

如果在没有 getter 的情况下定义了 setter，则此规则会发出警告。使用选项 getWithoutSet，如果你有一个没有 setter 的 getter，它会发出警告。

# 规则详情

此规则强制执行一种样式，它要求每个定义了 setter 的属性都有一个 getter。

通过激活选项 getWithoutSet，它强制每个定义了 getter 的属性都存在一个 setter。

此规则始终检查对象字面和属性描述符。默认情况下，它还检查类声明和类表达式。

# 选项

setWithoutGet 设置为 true 将对没有 getter 的 setter 发出警告（默认 true）。
getWithoutSet 设置为 true 将警告没有设置器的获取器（默认 false）。
enforceForClassMembers 设置为 true 还会将此规则应用于类 getter/setter（默认 true）。如果您希望此规则忽略类声明和类表达式，请将 enforceForClassMembers 设置为 false。

# setWithoutGet

默认 { "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;
    }
});

默认 { "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

{ "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;
    }
});

{ "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;
    }
});

# enforceForClassMembers

当 enforceForClassMembers 设置为 true（默认）时：

"getWithoutSet": true 也会对类中没有设置器的 getter 发出警告。
"setWithoutGet": true 也会对类中没有 getter 的 setter 发出警告。

{ "getWithoutSet": true, "enforceForClassMembers": true } 的错误代码示例：

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

class Foo {
    get a() {
        return this.val;
    }
}

class Bar {
    static get a() {
        return this.val;
    }
}

const Baz = class {
    get a() {
        return this.val;
    }
    static set a(value) {
        this.val = value;
    }
}

{ "setWithoutGet": true, "enforceForClassMembers": true } 的错误代码示例：

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

class Foo {
    set a(value) {
        this.val = value;
    }
}

const Bar = class {
    static set a(value) {
        this.val = value;
    }
}

当 enforceForClassMembers 设置为 false 时，此规则将忽略类。

{ "getWithoutSet": true, "setWithoutGet": true, "enforceForClassMembers": false } 的正确代码示例：

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

class Foo {
    get a() {
        return this.val;
    }
}

class Bar {
    static set a(value) {
        this.val = value;
    }
}

const Baz = class {
    static get a() {
        return this.val;
    }
}

const Quux = class {
    set a(value) {
        this.val = value;
    }
}

# 已知限制

由于静态分析的限制，此规则不考虑可能的副作用，并且在某些情况下可能不会报告具有计算键的 getter/setter 的缺失对，如下例所示：

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

var a = 1;

// no warnings
var o = {
    get [a++]() {
        return this.val;
    },
    set [a++](value) {
        this.val = value;
    }
};

此外，此规则不允许对象字面量和类定义中的重复键，并且在某些情况下，重复键可能不会报告 getter/setter 的缺失对，如下例所示：

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

// no warnings
var o = {
    get a() {
        return this.val;
    },
    a: 1,
    set a(value) {
        this.val = value;
    }
};

上面的代码创建了一个只有属性 "a" 的 setter 的对象。

如果您还想禁止对象字面量中的重复键，请参阅 no-dupe-keys。

如果您还想在类定义中禁止重复名称，请参阅 no-dupe-class-members。

# 何时不使用

如果您不关心对象上同时存在 setter 和 getter，则可以关闭此规则。

← valid-typeof arrow-body-style →