chore: rewrite SubtreeRetainer into Typescript (#3137)

* chore: rewrite SubtreeRetainer in Typescript

* chore: mark attributes as protected
This commit is contained in:
David Wheatley 2021-10-31 00:28:30 +02:00 committed by GitHub
parent 1e4ab61878
commit 5de64e14bc

View File

@ -22,12 +22,16 @@
* @see https://mithril.js.org/lifecycle-methods.html#onbeforeupdate * @see https://mithril.js.org/lifecycle-methods.html#onbeforeupdate
*/ */
export default class SubtreeRetainer { export default class SubtreeRetainer {
protected callbacks: (() => any)[];
protected data: Record<string, any>;
/** /**
* @param {...callbacks} callbacks Functions returning data to keep track of. * @param callbacks Functions returning data to keep track of.
*/ */
constructor(...callbacks) { constructor(...callbacks: (() => any)[]) {
this.callbacks = callbacks; this.callbacks = callbacks;
this.data = {}; this.data = {};
// Build the initial data, so it is available when calling // Build the initial data, so it is available when calling
// needsRebuild from the onbeforeupdate hook. // needsRebuild from the onbeforeupdate hook.
this.needsRebuild(); this.needsRebuild();
@ -36,11 +40,8 @@ export default class SubtreeRetainer {
/** /**
* Return whether any data has changed since the last check. * Return whether any data has changed since the last check.
* If so, Mithril needs to re-diff the vnode and its children. * If so, Mithril needs to re-diff the vnode and its children.
*
* @return {boolean}
* @public
*/ */
needsRebuild() { needsRebuild(): boolean {
let needsRebuild = false; let needsRebuild = false;
this.callbacks.forEach((callback, i) => { this.callbacks.forEach((callback, i) => {
@ -57,22 +58,17 @@ export default class SubtreeRetainer {
/** /**
* Add another callback to be checked. * Add another callback to be checked.
*
* @param {...Function} callbacks
* @public
*/ */
check(...callbacks) { check(...callbacks: (() => any)[]): void {
this.callbacks = this.callbacks.concat(callbacks); this.callbacks = this.callbacks.concat(callbacks);
// Update the data cache when new checks are added. // Update the data cache when new checks are added.
this.needsRebuild(); this.needsRebuild();
} }
/** /**
* Invalidate the subtree, forcing it to be rerendered. * Invalidate the subtree, forcing it to be redrawn.
*
* @public
*/ */
invalidate() { invalidate(): void {
this.data = {}; this.data = {};
} }
} }