From 0ae7ab601b400f84bcdce64b88c67d1fabdda02b Mon Sep 17 00:00:00 2001 From: Konstantin Ikonnikov Date: Tue, 28 Apr 2020 19:59:41 +0300 Subject: [PATCH 1/4] Add definitions for WeakRef and FinalizationRegistry Fixes #32393 --- src/lib/esnext.d.ts | 1 + src/lib/esnext.weakref.d.ts | 67 +++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 src/lib/esnext.weakref.d.ts diff --git a/src/lib/esnext.d.ts b/src/lib/esnext.d.ts index 36c759ff9123c..d42e73cad9f1e 100644 --- a/src/lib/esnext.d.ts +++ b/src/lib/esnext.d.ts @@ -2,3 +2,4 @@ /// /// /// +/// diff --git a/src/lib/esnext.weakref.d.ts b/src/lib/esnext.weakref.d.ts new file mode 100644 index 0000000000000..d6c57fec144f9 --- /dev/null +++ b/src/lib/esnext.weakref.d.ts @@ -0,0 +1,67 @@ +interface WeakRef { + readonly [Symbol.toStringTag]: "WeakRef"; + + /** + * Returns the WeakRef instance's target object, or undefined if the target object has been + * reclaimed. + */ + deref(): T | undefined; +} + +interface WeakRefConstructor { + readonly prototype: WeakRef; + + /** + * Creates a WeakRef instance for the given target object. + * @param target The target object for the WeakRef instance. + */ + new(target?: T): WeakRef; +} + +declare var WeakRef: WeakRefConstructor; + +interface FinalizationRegistry { + readonly [Symbol.toStringTag]: "FinalizationRegistry"; + + /** + * Registers an object with the registry. + * @param target The target object to register. + * @param heldValue The value to pass to the finalizer for this object. This cannot be the + * target object. + * @param unregisterToken The token to pass to the unregister method to unregister the target + * object. If provided (and not undefined), this must be an object. If not provided, the target + * cannot be unregistered. + */ + register(target: object, heldValue: any, unregisterToken?: object): void; + + /** + * Unregisters an object from the registry. + * @param unregisterToken The token that was used as the unregisterToken argument when calling + * register to register the target object. + */ + unregister(unregisterToken: object): void; + + /** + * Triggers callbacks for an implementation-chosen number of objects in the registry that have + * been reclaimed but whose callbacks have not yet been called. + * + * Note: The number of entries for reclaimed objects that are cleaned up from the registry + * (calling the cleanup callbacks) is implementation-defined. An implementation might remove + * just one eligible entry, or all eligible entries, or somewhere in between. + * @param callback If given, the registry uses the given callback instead of the one it was + * created with. + */ + cleanupSome(callback: (heldValue: any) => void): void; +} + +interface FinalizationRegistryConstructor { + readonly prototype: FinalizationRegistry; + + /** + * Creates a finalization registry with an associated cleanup callback + * @param cleanupCallback The callback to call after an object in the registry has been reclaimed. + */ + new(cleanupCallback: (heldValue: any) => void): FinalizationRegistry; +} + +declare var FinalizationRegistry: FinalizationRegistryConstructor; From a5ce6c2cd636f7054a2fb5d2b13bbb8f0476f923 Mon Sep 17 00:00:00 2001 From: Konstantin Ikonnikov Date: Tue, 28 Apr 2020 20:23:38 +0300 Subject: [PATCH 2/4] Mark callback parameter in FinalizationRegistry#cleanupSome() as optional --- src/lib/esnext.weakref.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/esnext.weakref.d.ts b/src/lib/esnext.weakref.d.ts index d6c57fec144f9..7fc59dfb8ad1b 100644 --- a/src/lib/esnext.weakref.d.ts +++ b/src/lib/esnext.weakref.d.ts @@ -51,7 +51,7 @@ interface FinalizationRegistry { * @param callback If given, the registry uses the given callback instead of the one it was * created with. */ - cleanupSome(callback: (heldValue: any) => void): void; + cleanupSome(callback?: (heldValue: any) => void): void; } interface FinalizationRegistryConstructor { From 6548776df0734dadd085a6bb08a44225b8bf534c Mon Sep 17 00:00:00 2001 From: Konstantin Ikonnikov Date: Thu, 21 May 2020 01:47:31 +0300 Subject: [PATCH 3/4] Make FinalizationRegistry.prototype.cleanupSome optional --- src/lib/esnext.weakref.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/esnext.weakref.d.ts b/src/lib/esnext.weakref.d.ts index 7fc59dfb8ad1b..8275b30bed305 100644 --- a/src/lib/esnext.weakref.d.ts +++ b/src/lib/esnext.weakref.d.ts @@ -51,7 +51,7 @@ interface FinalizationRegistry { * @param callback If given, the registry uses the given callback instead of the one it was * created with. */ - cleanupSome(callback?: (heldValue: any) => void): void; + cleanupSome?(callback?: (heldValue: any) => void): void; } interface FinalizationRegistryConstructor { From b6c29c713a7cfff87dae461ca1acba9239b865b4 Mon Sep 17 00:00:00 2001 From: Konstantin Ikonnikov Date: Fri, 24 Jul 2020 00:11:46 +0400 Subject: [PATCH 4/4] Remove FinalizationRegistry.prototype.cleanupSome() --- src/lib/esnext.weakref.d.ts | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/src/lib/esnext.weakref.d.ts b/src/lib/esnext.weakref.d.ts index 8275b30bed305..337aa11f3e319 100644 --- a/src/lib/esnext.weakref.d.ts +++ b/src/lib/esnext.weakref.d.ts @@ -40,18 +40,6 @@ interface FinalizationRegistry { * register to register the target object. */ unregister(unregisterToken: object): void; - - /** - * Triggers callbacks for an implementation-chosen number of objects in the registry that have - * been reclaimed but whose callbacks have not yet been called. - * - * Note: The number of entries for reclaimed objects that are cleaned up from the registry - * (calling the cleanup callbacks) is implementation-defined. An implementation might remove - * just one eligible entry, or all eligible entries, or somewhere in between. - * @param callback If given, the registry uses the given callback instead of the one it was - * created with. - */ - cleanupSome?(callback?: (heldValue: any) => void): void; } interface FinalizationRegistryConstructor {