no-restricted-properties

对象上的某些属性可能在代码库中被禁止。这对于取消API或限制模块方法的使用很有用。例如，您可能希望使用不允许describe.only使用摩卡或者告诉人们使用时Object.assign代替_.extend。

规则细节

此规则查找在给定对象名称上访问给定属性键时，可以在读取属性值或将其作为函数调用时使用。您可以指定一个可选消息来指示替代API或限制原因。

选项

此规则接受一个对象列表，其中指定了对象名称和属性名称：

{
    "rules": {
        "no-restricted-properties": [2, {
            "object": "disallowedObjectName",
            "property": "disallowedPropertyName"
        }]
    }
}

多个对象/属性值可以被禁止，并且您可以指定一个可选消息：

{
    "rules": {
        "no-restricted-properties": [2, {
            "object": "disallowedObjectName",
            "property": "disallowedPropertyName"
        }, {
            "object": "disallowedObjectName",
            "property": "anotherDisallowedPropertyName",
            "message": "Please use allowedObjectName.allowedPropertyName."
        }]
    }
}

如果省略对象名称，则不允许所有对象的属性：

{
    "rules": {
        "no-restricted-properties": [2, {
            "property": "__defineGetter__",
            "message": "Please use Object.defineProperty instead."
        }]
    }
}

如果省略属性名称，则不允许访问给定对象的任何属性：

{
    "rules": {
        "no-restricted-properties": [2, {
            "object": "require",
            "message": "Please call require() directly."
        }]
    }
}

此规则的错误代码示例：

/* eslint no-restricted-properties: [2, {
    "object": "disallowedObjectName",
    "property": "disallowedPropertyName"
}] */

var example = disallowedObjectName.disallowedPropertyName; /*error Disallowed object property: disallowedObjectName.disallowedPropertyName.*/

disallowedObjectName.disallowedPropertyName(); /*error Disallowed object property: disallowedObjectName.disallowedPropertyName.*/

/* eslint no-restricted-properties: [2, {
    "property": "__defineGetter__"
}] */

foo.__defineGetter__(bar, baz);

/* eslint no-restricted-properties: [2, {
    "object": "require"
}] */

require.resolve('foo');

此规则的正确代码示例：

/* eslint no-restricted-properties: [2, {
    "object": "disallowedObjectName",
    "property": "disallowedPropertyName"
}] */

var example = disallowedObjectName.somePropertyName;

allowedObjectName.disallowedPropertyName();

/* eslint no-restricted-properties: [2, {
    "object": "require"
}] */

require('foo');

何时不使用它

如果您没有要限制的任何对象/属性组合，则不应使用此规则。

相关规则

• no-restricted-globals

• no-restricted-syntax

版本

该规则在 ESLint 3.5.0 中引入。

资源

• Rule source

• Documentation source