mirror of
https://github.com/denoland/deno.git
synced 2024-10-29 08:58:01 -04:00
a21a5ad2fa
Resolves #1705 This PR adds the Deno APIs as a global namespace named `Deno`. For backwards compatibility, the ability to `import * from "deno"` is preserved. I have tried to convert every test and internal code the references the module to use the namespace instead, but because I didn't break compatibility I am not sure. On the REPL, `deno` no longer exists, replaced only with `Deno` to align with the regular runtime. The runtime type library includes both the namespace and module. This means it duplicates the whole type information. When we remove the functionality from the runtime, it will be a one line change to the library generator to remove the module definition from the type library. I marked a `TODO` in a couple places where to remove the `"deno"` module, but there are additional places I know I didn't mark.
107 lines
4.4 KiB
TypeScript
107 lines
4.4 KiB
TypeScript
// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
|
|
// This is a "special" module, in that it define the global runtime scope of
|
|
// Deno, and therefore it defines a lot of the runtime environemnt that code
|
|
// is evaluated in. We use this file to automatically build the runtime type
|
|
// library.
|
|
|
|
// Modules which will make up part of the global public API surface should be
|
|
// imported as namespaces, so when the runtime tpye library is generated they
|
|
// can be expressed as a namespace in the type library.
|
|
import * as blob from "./blob";
|
|
import * as consoleTypes from "./console";
|
|
import * as customEvent from "./custom_event";
|
|
import * as deno from "./deno";
|
|
import * as domTypes from "./dom_types";
|
|
import * as event from "./event";
|
|
import * as eventTarget from "./event_target";
|
|
import * as formData from "./form_data";
|
|
import * as fetchTypes from "./fetch";
|
|
import * as headers from "./headers";
|
|
import * as textEncoding from "./text_encoding";
|
|
import * as timers from "./timers";
|
|
import * as url from "./url";
|
|
import * as urlSearchParams from "./url_search_params";
|
|
import * as workers from "./workers";
|
|
import * as performanceUtil from "./performance";
|
|
|
|
// These imports are not exposed and therefore are fine to just import the
|
|
// symbols required.
|
|
import { globalEval } from "./global_eval";
|
|
import { libdeno } from "./libdeno";
|
|
|
|
// During the build process, augmentations to the variable `window` in this
|
|
// file are tracked and created as part of default library that is built into
|
|
// Deno, we only need to declare the enough to compile Deno.
|
|
declare global {
|
|
const console: consoleTypes.Console;
|
|
const setTimeout: typeof timers.setTimeout;
|
|
}
|
|
|
|
// A reference to the global object.
|
|
export const window = globalEval("this");
|
|
// A self reference to the global object.
|
|
window.window = window;
|
|
|
|
// This is the Deno namespace, it is handled differently from other window
|
|
// properties when building the runtime type library, as the whole module
|
|
// is flattened into a single namespace.
|
|
|
|
window.Deno = deno;
|
|
Object.freeze(window.Deno);
|
|
|
|
// Globally available functions and object instances.
|
|
window.atob = textEncoding.atob;
|
|
window.btoa = textEncoding.btoa;
|
|
window.fetch = fetchTypes.fetch;
|
|
window.clearTimeout = timers.clearTimer;
|
|
window.clearInterval = timers.clearTimer;
|
|
window.console = new consoleTypes.Console(libdeno.print);
|
|
window.setTimeout = timers.setTimeout;
|
|
window.setInterval = timers.setInterval;
|
|
|
|
// When creating the runtime type library, we use modifications to `window` to
|
|
// determine what is in the global namespace. When we put a class in the
|
|
// namespace, we also need its global instance type as well, otherwise users
|
|
// won't be able to refer to instances.
|
|
// We have to export the type aliases, so that TypeScript _knows_ they are
|
|
// being used, which it cannot statically determine within this module.
|
|
window.Blob = blob.DenoBlob;
|
|
export type Blob = blob.DenoBlob;
|
|
|
|
// TODO(ry) Do not export a class implementing the DOM, export the DOM
|
|
// interface. See this comment for implementation hint:
|
|
// https://github.com/denoland/deno/pull/1396#discussion_r243711502
|
|
// window.File = file.DenoFile;
|
|
// export type File = file.DenoFile;
|
|
|
|
window.CustomEventInit = customEvent.CustomEventInit;
|
|
export type CustomEventInit = customEvent.CustomEventInit;
|
|
window.CustomEvent = customEvent.CustomEvent;
|
|
export type CustomEvent = customEvent.CustomEvent;
|
|
window.EventInit = event.EventInit;
|
|
export type EventInit = event.EventInit;
|
|
window.Event = event.Event;
|
|
export type Event = event.Event;
|
|
window.EventTarget = eventTarget.EventTarget;
|
|
export type EventTarget = eventTarget.EventTarget;
|
|
window.URL = url.URL;
|
|
export type URL = url.URL;
|
|
window.URLSearchParams = urlSearchParams.URLSearchParams;
|
|
export type URLSearchParams = urlSearchParams.URLSearchParams;
|
|
|
|
// Using the `as` keyword to use standard compliant interfaces as the Deno
|
|
// implementations contain some implementation details we wouldn't want to
|
|
// expose in the runtime type library.
|
|
window.Headers = headers.Headers as domTypes.HeadersConstructor;
|
|
export type Headers = domTypes.Headers;
|
|
window.FormData = formData.FormData as domTypes.FormDataConstructor;
|
|
export type FormData = domTypes.FormData;
|
|
|
|
window.TextEncoder = textEncoding.TextEncoder;
|
|
export type TextEncoder = textEncoding.TextEncoder;
|
|
window.TextDecoder = textEncoding.TextDecoder;
|
|
export type TextDecoder = textEncoding.TextDecoder;
|
|
|
|
window.performance = new performanceUtil.Performance();
|
|
|
|
window.workerMain = workers.workerMain;
|