feat: add destroy lifecycle hook to blocks #6678
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
BeksOmega
changed the title
github-actions
bot
added
PR: feature
gonfunko
reviewed
Dec 5, 2022
core/block.ts
Outdated
| @@ -95,6 +95,9 @@ export class Block implements IASTNodeLocation, IDeletable { | |||
| /** An optional method called during initialization. */ | |||
| init?: (() => AnyDuringMigration)|null = undefined; | |||
|
|
|||
| /** An optional method called during disposal. */ | |||
| destroy?: (() => AnyDuringMigration)|null = undefined; | |||
There was a problem hiding this comment.
Why AnyDuringMigration as the return type rather than void? It also seems like it might be nicer to make it non-optional and just initialize it to null rather than undefined?
There was a problem hiding this comment.
I went with void & removed the |null. I thought undefined made more sense as a default value, since this property /is/ optional, and its either defined or its not.
gonfunko
approved these changes
Dec 5, 2022
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.
The basics
npm run formatandnpm run lintThe details
Resolves
Fixes #6319 maybe actually finally
Proposed Changes
Adds a new
destroylifecycle hook that is called at the end ofdisposewhich can be used for cleanup (e.g. of any backing data models for the block).Reason for Changes
Sometimes you need to clean data up!
Test Coverage
Adds tests to make sure dispose gets called at the proper time, and events fired from it are actually fired.
Documentation
N/A
Additional Information
Putting this up as a draft until we're sure we're definitely happy with the design.