diff options
Diffstat (limited to 'js/globals.ts')
-rw-r--r-- | js/globals.ts | 75 |
1 files changed, 50 insertions, 25 deletions
diff --git a/js/globals.ts b/js/globals.ts index 5a0ca7cc6..6f29d97d4 100644 --- a/js/globals.ts +++ b/js/globals.ts @@ -1,23 +1,33 @@ // Copyright 2018 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 domTypes from "./dom_types"; import * as file from "./file"; -import * as formdata from "./form_data"; -import * as console_ from "./console"; -import * as fetch_ from "./fetch"; -import { Headers } from "./headers"; -import { globalEval } from "./global_eval"; -import { libdeno } from "./libdeno"; +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 urlSearchParams from "./url_search_params"; -import * as domTypes from "./dom_types"; + +// 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. - +// Deno, we only need to declare the enough to compile Deno. declare global { - const console: console_.Console; + const console: consoleTypes.Console; const setTimeout: typeof timers.setTimeout; // tslint:disable-next-line:variable-name const TextEncoder: typeof textEncoding.TextEncoder; @@ -25,26 +35,41 @@ declare global { // A reference to the global object. export const window = globalEval("this"); +// A self reference to the global object. window.window = window; -window.setTimeout = timers.setTimeout; -window.setInterval = timers.setInterval; -window.clearTimeout = timers.clearTimer; -window.clearInterval = timers.clearTimer; - -window.console = new console_.Console(libdeno.print); -window.TextEncoder = textEncoding.TextEncoder; -window.TextDecoder = textEncoding.TextDecoder; +// 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; +window.File = file.DenoFile; +export type File = file.DenoFile; window.URLSearchParams = urlSearchParams.URLSearchParams; +export type URLSearchParams = urlSearchParams.URLSearchParams; -window.fetch = fetch_.fetch; +// 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; -// using the `as` keyword to mask the internal types when generating the -// runtime library -window.Headers = Headers as domTypes.HeadersConstructor; -window.Blob = blob.DenoBlob; -window.File = file.DenoFile; -window.FormData = formdata.FormData as domTypes.FormDataConstructor; +// While these are classes, they have their global instance types created in +// other type definitions, therefore we do not have to include them here. +window.TextEncoder = textEncoding.TextEncoder; +window.TextDecoder = textEncoding.TextDecoder; |