[🥸🤠🥳]: Add new APIs #1
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
haneenmahd
added
documentation
haneenmahd
commented
Jul 24, 2022
lib/registerEffect.ts
Outdated
Comment on lines
1
to
14
| /** | ||
| * Register an effect for the state object specified in the argument. | ||
| * This function also supports specifying multiple state objects as arguments | ||
| * when you want to have a common state for multiple state objects. | ||
| * | ||
| * ```ts | ||
| * createEffect((newValue) => { | ||
| * // callback when the state is set | ||
| * }, state); | ||
| * ``` | ||
| * | ||
| * @param callback {StateCallback<T>} | ||
| * @param objects {StateObject<T> | StateObject<T>[]} | ||
| */ |
There was a problem hiding this comment.
Should add docs which warns the user that the registerEffect should be called before changing a state for it to take effect!
|
|
||
| export { useState, useEffect }; | ||
| export { createState, registerEffect }; |
There was a problem hiding this comment.
State class will be exported when we think it is ready for extensible purposes 👍🏻 !
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.
This PR adds new APIs to the library.