Automattic / Automattic/monk

Return type of update() is incorrect

Open
#334 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
1.8k
Forks
180
PR merge metrics
No merged PRs in 30d

Description

In the current version of Monk, `v7.3.3` the return type of `update()` is `UpdateWriteOpResult`, I think it should be `UpdateResult`.

https://github.com/Automattic/monk/blob/027ab439726d3ce87553c76caf777de32db5b12c/index.d.ts#L335-L339

(Same with the other `update()` calls, perhaps?)

Contributor guide

No contributing guide indexed for this repository

Research direction

Open index.d.ts at lines 335-339 and inspect the return type declared for update(). Check the other update() declarations mentioned in the issue, then confirm that each uses UpdateResult rather than UpdateWriteOpResult; done means the declarations consistently expose the intended return type.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, mongodb
Domain
databases
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.