Skip to content
Complete LogoComplete

complete/prefer-is-array

💼 This rule is enabled in the ✅ recommended config.

📝 Requires using the complete-common isArray helper instead of Array.isArray.

🔧 This rule is automatically fixable by the --fix CLI option.

The Array.isArray function is the standard way in JavaScript/TypeScript to check if something is an array. However, the return type for it is arg is any[]. This is bad, because any disables the type-checker. Thus, this rule forces you to use the isArray helper function from the complete-common library, which is the same thing as the Array.isArray function, but has a proper return type of arg is unknown[].

Rule Details

Section titled “Rule Details”
// Bad
if (Array.isArray()) {
}


// Good
if (isArray()) {
}

Options

Section titled “Options”

This rule is not configurable.

Resources

Section titled “Resources”