Mark scan() and scanAll() parameters as optional
#564
Merged
Conversation
This file contains hidden or 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
filmaj
requested changes
Mar 19, 2025
types/tables.d.ts
Outdated
| scan(params: ScanParams): Promise<ScanOutput<Item>>; | ||
| scan(params: ScanParams, callback: Callback<ScanOutput<Item>>): void; | ||
| scan(params?: ScanParams): Promise<ScanOutput<Item>>; | ||
| scan(params?: ScanParams, callback: Callback<ScanOutput<Item>>): void; |
There was a problem hiding this comment.
I don't think a required parameter can follow an optional parameter. I would probably split this out into two further function signatures.
I'll fork from your branch and send a new PR with an adjustment, to maintain your credit.
…for optional params when using callbacks
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.
The documentation for the
scan()andscanAll()methods (https://arc.codes/docs/en/reference/runtime-helpers/node.js#instance-methods) say that the parameters are optional. However, this isn't reflected in the type definitions. This PR fixes that.