First pass at derived state documentation #269
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
Deploying with
|
| Latest commit: |
9b8e46e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9a7ad5b8.contributing-docs.pages.dev |
| Branch Preview URL: | https://ps-add-derived-state-to-stat.contributing-docs.pages.dev |
withinfocus
reviewed
Jan 12, 2024
| in application state. Derived state exists to store this kind of data in memory and keep it up to | ||
| date when the underlying observable state changes. | ||
|
|
||
| ## `DeriveDefinition` |
There was a problem hiding this comment.
⛏️ and it may be too late here, but why not "derived" for the object name? This would coincide with the "derived" state lower down. Or is this a "derivation" definition?
There was a problem hiding this comment.
The thinking was just that the state has already been done, hence past tense while the definition is describing how to derive.
| - `deps` - dependencies used to instantiate the derived state. These are provided when the | ||
| `DerivedState` class is instantiated. This object should contain all of the application runtime | ||
| dependencies for transform the from parent state to the derived state. | ||
| - `cleanupDelayMs` (optional) - Takes the number of milliseconds to wait before cleaning up the |
There was a problem hiding this comment.
❓ What's the underlying purpose for this?
There was a problem hiding this comment.
This is effectively the lifetime of derived values to live in memory once observers unsubscribe.
If you have some data that is expensive to derive, you may want to increase this to minimize the chance that data must be re-calculated.
Co-authored-by: Matt Bishop <[email protected]>
MGibson1
merged commit 7b84808
into
add-state-provider-framework-deep-dive
3 checks passed
justindbaur
added a commit
that referenced
this pull request
Sep 23, 2024
* Add State Provider Framework Deep Dive * Update Deep Dive * Apply Suggestions from Matt Co-authored-by: Matt Gibson <[email protected]> * Update docs/architecture/deep-dives/state/index.md Co-authored-by: Matt Gibson <[email protected]> * More Feedback * Refine * Add Diagram and FAQ * Apply suggestions from code review Co-authored-by: Matt Bishop <[email protected]> * Run Prettier * Stub Out `deserializer` and add comment Co-authored-by: audrey-jensen <[email protected]> * Clarify Wording * First pass at derived state documentation (#269) * First pass at derived state documentation * `npm run prettier` 🤖 * Apply suggestions from code review Co-authored-by: Matt Bishop <[email protected]> --------- Co-authored-by: Matt Bishop <[email protected]> * Apply suggestions from code review Co-authored-by: Matt Bishop <[email protected]> * Fill In TODOs * Added optional constructor parameter and updated mapping instructions. (#296) * Added optional constructor parameter and updated mapping instructions. * Fixed table * Changed verbiage. * Updated verbiage. * Updated to include clearOn and UserKeyDefinition * Update `ActiveUserState` Information * Fix AUS Warning Co-authored-by: ✨ Audrey ✨ <[email protected]> * Change to instruction Co-authored-by: ✨ Audrey ✨ <[email protected]> * Move to Present Tense --------- Co-authored-by: Matt Gibson <[email protected]> Co-authored-by: Matt Bishop <[email protected]> Co-authored-by: audrey-jensen <[email protected]> Co-authored-by: Todd Martin <[email protected]> Co-authored-by: Todd Martin <[email protected]>
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.
Objective
Adding documentation for derived state to the state provider deep dive.
I moved this to a separate file because it felt optional and different enough to warrant some extra separation.