sindresorhus/eslint-plugin-unicorn
`no-object-as-default-parameter` should ignore for objects with required parameters
Fermée
#2 199 ouverte le 9 oct. 2023
bughelp wantedtypes
Métriques du dépôt
- Stars
- (5 022 étoiles)
- Métriques de merge PR
- (Merge moyen 1j 16h) (399 PRs mergées en 30 j)
Description
Sometimes a method has a required set of option parameters. e.g. min and max.
function valueBetween(range: {min: number, max: number} = { min: 0, max: 10 }) {} ✔️
In this case it should be OK to use object default parameters because both min and max are required. Or to be more precise, it should be ok if defined default properties === required properties. It is not OK if any optional property is provided.
Yes, it it possible for plain JS users to fall through, but they are also likely to fail with the types in general or cause conflicts due to mismatching boundaries:
valueBetween({min: 'a', max: 10}); ❌
valueBetween({min: 100}); ❌
Otherwise it is impossible to implement the method parameter default in a type safe way.
function valueBetween(range: {min: number, max: number} = {} ❌) { // ts-error
const { min = 0, max = 10 } = options;
}
function valueBetween(range: {min: number, max: number} = { min: 0, max: 10 }) {} :check ✔️
function valueBetween(range: {min: number, max: number, step: number} = { min: 0, max: 10 }) {} ❌
function valueBetween(range: {min: number, max: number, step?: number} = { min: 0, max: 10, step: 1 }) {} ❌