UNPKG

@typescript-eslint/eslint-plugin

Version:
51 lines (36 loc) 1.21 kB
--- description: 'Enforce the use of `for-of` loop over the standard `for` loop where possible.' --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; > 🛑 This file is source code, not the primary documentation location! 🛑 > > See **https://typescript-eslint.io/rules/prefer-for-of** for documentation. Many developers default to writing `for (let i = 0; i < ...` loops to iterate over arrays. However, in many of those arrays, the loop iterator variable (e.g. `i`) is only used to access the respective element of the array. In those cases, a `for-of` loop is easier to read and write. This rule recommends a for-of loop when the loop index is only used to read from an array that is being iterated. ## Examples <Tabs> <TabItem value="❌ Incorrect"> ```ts declare const array: string[]; for (let i = 0; i < array.length; i++) { console.log(array[i]); } ``` </TabItem> <TabItem value="✅ Correct"> ```ts declare const array: string[]; for (const x of array) { console.log(x); } for (let i = 0; i < array.length; i++) { // i is used, so for-of could not be used. console.log(i, array[i]); } ``` </TabItem> </Tabs> {/* Intentionally Omitted: When Not To Use It */}