docs: document when and asyncWhen options #249 - #1085
Open
AzazelSensei wants to merge 1 commit into
Open
Conversation
autorun and reaction already list their options. when and asyncWhen were still showing only the required arguments. Fixes mobxjs#249
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
1 participant
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.
Fixes #249
autorunandreactionalready document their optional arguments.whenandasyncWhenstill only showed the required ones.I added the live signatures and the same optional-parameter list style:
when:name,context,timeout,onErrorasyncWhen:name,timeout,contexttimeoutis milliseconds. If it fires first,whendisposes and throws (or callsonError);asyncWhenfails theFuture.