-
Notifications
You must be signed in to change notification settings - Fork 90
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Annotate Wasm async function return types #501
Merged
Merged
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
cycraig
added
Binding
Wasm
Related to Wasm bindings. Becomes part of the Wasm changelog
labels
Nov 22, 2021
10 tasks
…feat/wasm-async-types
PhilippGackstatter
approved these changes
Nov 23, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me from the Rust side, did not check the JS side.
eike-hass
approved these changes
Nov 23, 2021
abdulmth
approved these changes
Nov 23, 2021
cycraig
added
Added
A new feature that requires a minor release. Part of "Added" section in changelog
Breaking change
A change to the API that requires a major release. Part of "Changed" section in changelog
Wasm
Related to Wasm bindings. Becomes part of the Wasm changelog
and removed
Wasm
Related to Wasm bindings. Becomes part of the Wasm changelog
Added
A new feature that requires a minor release. Part of "Added" section in changelog
labels
Dec 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Breaking change
A change to the API that requires a major release. Part of "Changed" section in changelog
Wasm
Related to Wasm bindings. Becomes part of the Wasm changelog
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 of change
Manually annotates Typescript types for the return values of async functions in the Wasm bindings so they are no longer just
Promise<Any>
.This affects most of the
Client
functions:publishDocument -> Promise<Receipt>
publishDiff -> Promise<Receipt>
publishJSON -> Promise<Receipt>
resolve -> Promise<Document>
resolveHistory -> Promise<DocumentHistory>
resolveDiffHistory -> Promise<DiffChainHistory>
The following functions were left as-is pending the verifiable credential/presentation validation refactor (#312), since those types have not yet been ported properly:
checkPresentation -> Promise<Any>
checkCredential -> Promise<Any>
Also changes
Array<any>
returns forDocumentHistory
,IntegrationChainHistory
, andDiffChainHistory
.NOTE: the signature of
Client.publishDocument
has changed:publishDocument(any)
topublishDocument(Document)
Links to any relevant issues
Partially addresses #309
Type of change
How the change has been tested
Local Wasm tests and examples pass locally. Manually inspected the new
Receipt
type and generated Typescript definitions.Change checklist