redis / ioredis / 21861667519

89%

Build Type

push

github

Committed by web-flow

Commit Message

fix(types): optional properties on RedisOptions allow explicit undefined (#2066)

* optional properties on RedisOptions, SentinelConnectionOptions, ClusterOptions

when exactOptionalPropertyTypes is true in the consuming application's tsconfig, you cannot send in an explicit undefined for these fields, causing the developer to jump through extra hoops needlessly to get i.e. the username and password provided to the options in a type-safe manner. This fix corrects this by explicitly specifying undefined as an allowed type on the username and password properties within RedisOptions, SentinelConnectionOptions, and ClusterOptions.

```ts
new Redis({
  ...
  password: process.env.REDIS_PASSWORD,
})
```

* fix: add missing | undefined to remaining optional properties

---------

Co-authored-by: Pavel Pashov <pavel.pashov@redis.com>

Run Details

1303 of 1521 branches covered (85.67%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

10 existing lines in 2 files now uncovered.

2497 of 2742 relevant lines covered (91.06%)

11715.23 hits per line