accessor-pairs

在 JavaScript 中创建一个只有属性 setter 的对象是一个常见的错误,但从来没有为它定义相应的 getter 。没有读取器,你不能读取属性,所以它最终不会被使用。

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;
    }
};

规则警告设置者是否在没有获取者的情况下定义。使用一个选项getWithoutSet,它会警告你是否还有没有 setter 的getter。

规则细节

这个规则强制执行一个样式,它需要为每个定义了 setter 的属性设置一个 getter。

通过激活该选项,getWithoutSet它为每个有读取器定义的属性强制执行一个 setter。

选项

  • setWithoutGet设置为true将在没有获取者的情况下向setter 发出警告(默认true)。
  • getWithoutSet设置为true将警告没有 setter 的获得者(默认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;
    }
});

何时不使用它

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

进一步阅读

版本

这条规则是在ESLint 0.22.0中引入的。

资源

扫码关注云+社区

领取腾讯云代金券