refactor(index.d.ts): make callbacks use the new Callback and CallbackWithoutResult types
#10550
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vkarpov15
reviewed
Aug 8, 2021
index.d.ts
Outdated
| @@ -2616,8 +2616,8 @@ declare module 'mongoose' { | |||
| */ | |||
| eachAsync(fn: (doc: DocType) => any, options?: { parallel?: number }): Promise<void>; | |||
| eachAsync(fn: (doc: DocType[]) => any, options: { parallel?: number, batchSize: number }): Promise<void>; | |||
| eachAsync(fn: (doc: DocType) => any, options?: { parallel?: number, batchSize?: number }, cb?: (err: CallbackError) => void): void; | |||
| eachAsync(fn: (doc: DocType[]) => any, options: { parallel?: number, batchSize: number }, cb?: (err: CallbackError) => void): void; | |||
| eachAsync(fn: (doc: DocType) => any, options?: { parallel?: number, batchSize?: number }, cb?: Callback): void; | |||
There was a problem hiding this comment.
This looks like it might be a problem: this change makes the eachAsync() callback take a param. Is this intentional or maybe we should have a CallbackNoResult type?
There was a problem hiding this comment.
You're right. It might be a problem. Although Callback still allows you to pass a callback receiving only the error, it can mislead users that callback is called with two arguments. It's better to create a CallbackNoResult as you mentioned.
thiagokisaki
changed the title
Callback type to avoid code repetitionCallback and CallbackWithoutResult types
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.