class-methods-use-this
強制類別方法使用 this
如果一個類別方法沒有使用 this，有時候可以將其變成靜態函式。如果您將方法轉換為靜態函式，則呼叫該特定方法的類別實例也必須轉換為靜態呼叫 (MyClass.callStaticMethod())
有可能會有一個類別方法沒有使用 this，例如
class A {
constructor() {
this.a = "hi";
}
print() {
console.log(this.a);
}
sayHi() {
console.log("hi");
}
}
let a = new A();
a.sayHi(); // => "hi"
在上面的例子中，sayHi 方法沒有使用 this，所以我們可以將其設為靜態方法
class A {
constructor() {
this.a = "hi";
}
print() {
console.log(this.a);
}
static sayHi() {
console.log("hi");
}
}
A.sayHi(); // => "hi"
另請注意，在上面的例子中，如果您將方法切換為靜態方法，則呼叫靜態方法的類別實例 (let a = new A(); a.sayHi();) 必須更新為靜態呼叫 (A.sayHi();)，而不是讓類別的實例呼叫方法
規則詳細資訊
此規則旨在標記未使用 this 的類別方法。
此規則的不正確程式碼範例
在遊樂場中開啟
/*eslint class-methods-use-this: "error"*/
class A {
() {
console.log("Hello World"); /*error Expected 'this' to be used by class method 'foo'.*/
}
}
此規則的正確程式碼範例
在遊樂場中開啟
/*eslint class-methods-use-this: "error"*/
class A {
foo() {
this.bar = "Hello World"; // OK, this is used
}
}
class B {
constructor() {
// OK. constructor is exempt
}
}
class C {
static foo() {
// OK. static methods aren't expected to use this.
}
static {
// OK. static blocks are exempt.
}
}
選項
此規則有兩個選項
"exceptMethods"允許指定的函式名稱被此規則忽略。"enforceForClassFields"強制將函式用作實例欄位初始化器時必須使用this。(預設值：true)
exceptMethods
"class-methods-use-this": [<enabled>, { "exceptMethods": [<...exceptions>] }]
"exceptMethods" 選項允許您傳遞一個您希望忽略警告的函式名稱陣列。例如，您可能有一個外部函式庫的規格要求您將方法覆寫為常規函式（而不是靜態方法），並且函式主體內部不使用 this。在這種情況下，您可以新增該方法以忽略警告。
在未使用 "exceptMethods" 時，此規則的不正確程式碼範例
在遊樂場中開啟
/*eslint class-methods-use-this: "error"*/
class A {
() {
}
}
在使用 exceptMethods 時，此規則的正確程式碼範例
在遊樂場中開啟
/*eslint class-methods-use-this: ["error", { "exceptMethods": ["foo", "#bar"] }] */
class A {
foo() {
}
#bar() {
}
}
enforceForClassFields
"class-methods-use-this": [<enabled>, { "enforceForClassFields": true | false }]
enforceForClassFields 選項強制將箭頭函式和函式表達式用作實例欄位初始化器時必須使用 this。(預設值：true)
在 { "enforceForClassFields": true } 選項（預設值）下，此規則的不正確程式碼範例
在遊樂場中開啟
/*eslint class-methods-use-this: ["error", { "enforceForClassFields": true }] */
class A {
() => {}
}
在 { "enforceForClassFields": true } 選項（預設值）下，此規則的正確程式碼範例
在遊樂場中開啟
/*eslint class-methods-use-this: ["error", { "enforceForClassFields": true }] */
class A {
foo = () => {this;}
}
在 { "enforceForClassFields": false } 選項下，此規則的正確程式碼範例
在遊樂場中開啟
/*eslint class-methods-use-this: ["error", { "enforceForClassFields": false }] */
class A {
foo = () => {}
}
版本
此規則是在 ESLint v3.4.0 中引入的。
延伸閱讀