# new-cap
要求构造函数名称以大写字母开头
JavaScript 中的 new
运算符创建特定类型对象的新实例。这种类型的对象由构造函数表示。由于构造函数只是常规函数,唯一的定义特征是 new
被用作调用的一部分。原生 JavaScript 函数以大写字母开头,以区分用作构造函数的函数和不用作构造函数的函数。许多样式指南建议遵循此模式,以便更轻松地确定将哪些函数用作构造函数。
var friend = new Person();
# 规则详情
此规则要求构造函数名称以大写字母开头。某些内置标识符不受此规则的约束。这些标识符是:
Array
Boolean
Date
Error
Function
Number
Object
RegExp
String
Symbol
BigInt
此规则的正确代码示例:
/*eslint new-cap: "error"*/
function foo(arg) {
return Boolean(arg);
}
# 选项
此规则有一个对象选项:
"newIsCap": true
(默认)要求所有new
运算符都以大写开头的函数调用。"newIsCap": false
允许使用小写开头或大写开头的函数调用new
运算符。"capIsNew": true
(默认)要求使用new
运算符调用所有以大写开头的函数。"capIsNew": false
允许在没有new
运算符的情况下调用以大写开头的函数。"newIsCapExceptions"
允许使用new
运算符调用指定的以小写开头的函数名。"newIsCapExceptionPattern"
允许使用new
运算符调用与指定的正则表达式模式匹配的任何小写开头的函数名称。"capIsNewExceptions"
允许在没有new
运算符的情况下调用指定的以大写开头的函数名。"capIsNewExceptionPattern"
允许在没有new
运算符的情况下调用任何与指定的正则表达式模式匹配的以大写开头的函数名称。"properties": true
(默认)启用对象属性检查"properties": false
禁用对对象属性的检查
# newIsCap
此规则使用默认 { "newIsCap": true }
选项的错误代码示例:
/*eslint new-cap: ["error", { "newIsCap": true }]*/
var friend = new person();
此规则使用默认 { "newIsCap": true }
选项的正确代码示例:
/*eslint new-cap: ["error", { "newIsCap": true }]*/
var friend = new Person();
此规则使用 { "newIsCap": false }
选项的正确代码示例:
/*eslint new-cap: ["error", { "newIsCap": false }]*/
var friend = new person();
# capIsNew
此规则使用默认 { "capIsNew": true }
选项的错误代码示例:
/*eslint new-cap: ["error", { "capIsNew": true }]*/
var colleague = Person();
此规则使用默认 { "capIsNew": true }
选项的正确代码示例:
/*eslint new-cap: ["error", { "capIsNew": true }]*/
var colleague = new Person();
此规则使用 { "capIsNew": false }
选项的正确代码示例:
/*eslint new-cap: ["error", { "capIsNew": false }]*/
var colleague = Person();
# newIsCapExceptions
此规则使用 { "newIsCapExceptions": ["events"] }
选项的其他正确代码示例:
/*eslint new-cap: ["error", { "newIsCapExceptions": ["events"] }]*/
var events = require('events');
var emitter = new events();
# newIsCapExceptionPattern
此规则使用 { "newIsCapExceptionPattern": "^person\\.." }
选项的其他正确代码示例:
/*eslint new-cap: ["error", { "newIsCapExceptionPattern": "^person\\.." }]*/
var friend = new person.acquaintance();
var bestFriend = new person.friend();
此规则使用 { "newIsCapExceptionPattern": "\\.bar$" }
选项的其他正确代码示例:
/*eslint new-cap: ["error", { "newIsCapExceptionPattern": "\\.bar$" }]*/
var friend = new person.bar();
# capIsNewExceptions
此规则使用 { "capIsNewExceptions": ["Person"] }
选项的其他正确代码示例:
/*eslint new-cap: ["error", { "capIsNewExceptions": ["Person"] }]*/
function foo(arg) {
return Person(arg);
}
# capIsNewExceptionPattern
此规则使用 { "capIsNewExceptionPattern": "^person\\.." }
选项的其他正确代码示例:
/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "^person\\.." }]*/
var friend = person.Acquaintance();
var bestFriend = person.Friend();
此规则使用 { "capIsNewExceptionPattern": "\\.Bar$" }
选项的其他正确代码示例:
/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "\\.Bar$" }]*/
foo.Bar();
此规则使用 { "capIsNewExceptionPattern": "^Foo" }
选项的其他正确代码示例:
/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "^Foo" }]*/
var x = Foo(42);
var y = Foobar(42);
var z = Foo.Bar(42);
# properties
此规则使用默认 { "properties": true }
选项的错误代码示例:
/*eslint new-cap: ["error", { "properties": true }]*/
var friend = new person.acquaintance();
此规则使用默认 { "properties": true }
选项的正确代码示例:
/*eslint new-cap: ["error", { "properties": true }]*/
var friend = new person.Acquaintance();
此规则使用 { "properties": false }
选项的正确代码示例:
/*eslint new-cap: ["error", { "properties": false }]*/
var friend = new person.acquaintance();
# 何时不使用
如果您的约定不需要构造函数使用大写字母,或者不需要大写函数仅用作构造函数,请关闭此规则。