summaryrefslogtreecommitdiff
path: root/cli/dts/lib.deno.unstable.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'cli/dts/lib.deno.unstable.d.ts')
-rw-r--r--cli/dts/lib.deno.unstable.d.ts20
1 files changed, 17 insertions, 3 deletions
diff --git a/cli/dts/lib.deno.unstable.d.ts b/cli/dts/lib.deno.unstable.d.ts
index 42f3c0202..92858ba31 100644
--- a/cli/dts/lib.deno.unstable.d.ts
+++ b/cli/dts/lib.deno.unstable.d.ts
@@ -422,11 +422,25 @@ declare namespace Deno {
| "es2019"
| "es2020"
| "esnext";
- /** List of names of type definitions to include. Defaults to `undefined`.
+ /** List of names of type definitions to include when type checking.
+ * Defaults to `undefined`.
*
* The type definitions are resolved according to the normal Deno resolution
- * irrespective of if sources are provided on the call. Like other Deno
- * modules, there is no "magical" resolution. For example:
+ * irrespective of if sources are provided on the call. In addition, unlike
+ * passing the `--config` option on startup, there is no base to resolve
+ * relative specifiers, so the specifiers here have to be fully qualified
+ * URLs or paths. For example:
+ *
+ * ```ts
+ * Deno.emit("./a.ts", {
+ * compilerOptions: {
+ * types: [
+ * "https://deno.land/x/pkg/types.d.ts",
+ * "/Users/me/pkg/types.d.ts",
+ * ]
+ * }
+ * });
+ * ```
*/
types?: string[];
/** Emit class fields with ECMAScript-standard semantics. Defaults to