-
Type:
Bug
-
Resolution: Fixed
-
Priority:
Major - P3
-
Affects Version/s: 7.8.0
-
Component/s: TypeScript
-
2
-
Not Needed
-
None
-
Not Needed
-
None
-
None
-
None
-
None
-
None
-
None
Use Case
As a... createIndex user
I want... the single variant to not show up as deprecated as that was not the intention of the most recent release
So that... I don't have to change my non-option using variants
await db.collection(collection).createIndex({ a: 1, b: 1 });
1:2 error `createIndex` is deprecated. Use the three parameter overload, which separates index options from
command options. This overload will be removed in a future major release @typescript-eslint/no-deprecated
User Experience
- No deprecation on the sample usage above
Dependencies
- Developer tools team upgrades
Risks/Unknowns
- None
Acceptance Criteria
Implementation Requirements
- createIndex will have three overloads, with one, two, and three parameters each.
- All overloads signatures will use only required parameters (no optional parameters).
Testing Requirements
- Set expectNotDeprecated to the one parameter and three parameter overloads
- Set expectDeprecated to the two parameter overload
Documentation Requirements
- Clarify in the 7.8.0 release notes that single argument use isn't changing
- keep NODE-7868 up to date with changes in
NODE-7968
Follow Up Requirements
- None
- related to
-
NODE-6893 Allow index options to pass through the driver unaltered, to be validated directly by the server
-
- Closed
-