improve docs to point to memory leak if ngOnDestroy is overridden in … #4001
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
…own component store
✅ Deploy Preview for ngrx-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
brandonroberts
requested changes
Aug 12, 2023
| @@ -14,6 +14,18 @@ Currently, Angular provides initializer tokens in a few areas. The `APP_INITIALI | |||
|
|
|||
| </div> | |||
|
|
|||
| <div class="alert is-important"> | |||
|
|
|||
| **Note:** If you override the `ngOnDestroy` method in your component store, you need to call `super.ngOnDestroy()`. Otherwise a memory leak may occur. | |||
There was a problem hiding this comment.
This would go better down at the bottom with the OnDestroy section.
There was a problem hiding this comment.
absolutely. i changed that.
| @@ -138,6 +138,18 @@ ComponentStore also implements the `OnDestroy` interface from `@angulare/core` t | |||
|
|
|||
| It also exposes a `destroy$` property on the ComponentStore class that can be used instead of manually creating a `Subject` to unsubscribe from any observables created in the component. | |||
|
|
|||
| <div class="alert is-important"> | |||
There was a problem hiding this comment.
Let's not put the code snippet inside the div.alert. Put it after the closing div
There was a problem hiding this comment.
To extend upon this comment, I think it would be better to the full snippet.
Also, instead of using the markdown code-block syntax, it's better to put wrap the code within a <code-example header="books-page.component.ts"> tag.
There was a problem hiding this comment.
ok i added the code snipped
timdeschryver
approved these changes
Aug 15, 2023
brandonroberts
approved these changes
Aug 19, 2023
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.
…own component store
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Closes #3982
What is the new behavior?
Does this PR introduce a breaking change?
Other information