1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-22 15:24:46 -05:00

feat(cli): add types for WeakRef/FinalizationRegistry (#8056)

Fixes #8051
This commit is contained in:
Kitson Kelly 2020-10-21 21:57:01 +11:00 committed by GitHub
parent be89bdfed7
commit 0fb39f9176
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 87 additions and 1 deletions

View file

@ -22,3 +22,4 @@ and limitations under the License.
/// <reference lib="esnext.intl" />
/// <reference lib="esnext.string" />
/// <reference lib="esnext.promise" />
/// <reference lib="esnext.weakref" />

72
cli/dts/lib.esnext.weakref.d.ts vendored Normal file
View file

@ -0,0 +1,72 @@
/*! *****************************************************************************
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
MERCHANTABLITY OR NON-INFRINGEMENT.
See the Apache Version 2.0 License for specific language governing permissions
and limitations under the License.
***************************************************************************** */
/// <reference no-default-lib="true"/>
interface WeakRef<T extends object> {
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<any>;
/**
* Creates a WeakRef instance for the given target object.
* @param target The target object for the WeakRef instance.
*/
new <T extends object>(target?: T): WeakRef<T>;
}
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;
}
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;

View file

@ -73,6 +73,7 @@ fn get_asset(name: &str) -> Option<&'static str> {
"lib.esnext.intl.d.ts" => inc!("lib.esnext.intl.d.ts"),
"lib.esnext.promise.d.ts" => inc!("lib.esnext.promise.d.ts"),
"lib.esnext.string.d.ts" => inc!("lib.esnext.string.d.ts"),
"lib.esnext.weakref.d.ts" => inc!("lib.esnext.weakref.d.ts"),
"lib.scripthost.d.ts" => inc!("lib.scripthost.d.ts"),
"lib.webworker.d.ts" => inc!("lib.webworker.d.ts"),
"lib.webworker.importscripts.d.ts" => {

View file

@ -2641,6 +2641,11 @@ itest!(wasm_unreachable {
exit_code: 1,
});
itest!(weakref {
args: "run --quiet --reload weakref.ts",
output: "weakref.ts.out",
});
itest!(top_level_await_order {
args: "run --allow-read top_level_await_order.js",
output: "top_level_await_order.out",

View file

@ -1,5 +1,5 @@
[WILDCARD]
DEBUG RS - [WILDCARD] - Files: 46
DEBUG RS - [WILDCARD] - Files: [WILDCARD]
DEBUG RS - [WILDCARD] - Nodes: [WILDCARD]
DEBUG RS - [WILDCARD] - Identifiers: [WILDCARD]
DEBUG RS - [WILDCARD] - Symbols: [WILDCARD]

1
cli/tests/weakref.ts Normal file
View file

@ -0,0 +1 @@
console.log(WeakRef, FinalizationRegistry);

1
cli/tests/weakref.ts.out Normal file
View file

@ -0,0 +1 @@
[Function: WeakRef] [Function: FinalizationRegistry]

View file

@ -106,6 +106,7 @@ pub const AVAILABLE_LIBS: &[&str] = &[
"esnext.promise",
"esnext.string",
"esnext.symbol",
"esnext.weakref",
"scripthost",
"webworker",
"webworker.importscripts",

View file

@ -488,6 +488,10 @@ delete Object.prototype.__proto__;
ts.libMap.set("deno.shared_globals", "lib.deno.shared_globals.d.ts");
ts.libMap.set("deno.unstable", "lib.deno.unstable.d.ts");
// TODO(@kitsonk) remove once added to TypeScript
ts.libs.push("esnext.weakref");
ts.libMap.set("esnext.weakref", "lib.esnext.weakref.d.ts");
// this pre-populates the cache at snapshot time of our library files, so they
// are available in the future when needed.
host.getSourceFile(