fix: update TypeScript declaration for KV#1608
Closed
raymondfeng wants to merge 1 commit intomasterfrom
Closed
Conversation
Closed
7 tasks
raymondfeng
commented
Jul 13, 2018
types/kv-model.d.ts
Outdated
| static iterateKeys( | ||
| filter?: Filter, | ||
| options?: Options, | ||
| ): Iterator<Promise<string>>; |
Contributor
Author
There was a problem hiding this comment.
This is not accurate. It should be AsyncIterator<string> which is only available with esnext. See https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-3.html.
Caveats
- Keep in mind that our support for async iterators relies on support for Symbol.asyncIterator to exist at runtime.
- You may need to polyfill Symbol.asyncIterator, which for simple purposes can be as simple as: (Symbol as any).asyncIterator = Symbol.asyncIterator || Symbol.for("Symbol.asyncIterator");
- You also need to include esnext in your --lib option, to get the AsyncIterator declaration if you do not already have it.
- Finally, if your target is ES5 or ES3, you’ll also need to set the --downlevelIterators flag.
virkt25
reviewed
Jul 13, 2018
types/kv-model.d.ts
Outdated
| * @promise | ||
| */ | ||
| static deleteAll( | ||
| key: string, |
Contributor
There was a problem hiding this comment.
Don't think it's supposed to take a key argument for deleteAll.
Contributor
Author
There was a problem hiding this comment.
Good catch. Will fix.
ade9f0f to
346d18b
Compare
bajtos
approved these changes
Jul 16, 2018
Member
bajtos
left a comment
There was a problem hiding this comment.
LGTM with one important comment.
I wish iterateKeys was conforming to AsyncIterator type from TypeScript and ES2019, but that's out of scope of this patch.
types/kv-model.d.ts
Outdated
| */ | ||
| keys( | ||
| static keys( | ||
| filter?: Filter, |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
update TypeScript declaration for KV
Related issues
Checklist
guide