diff options
author | Kitson Kelly <me@kitsonkelly.com> | 2018-11-09 11:09:18 +1100 |
---|---|---|
committer | Ryan Dahl <ry@tinyclouds.org> | 2018-11-09 08:39:49 -0800 |
commit | 34b6b86c76111396dd46e46015ad5536d6baa883 (patch) | |
tree | 6c668147aa01f2be031f10bc594100a392bb7531 /js | |
parent | 172f5a51332b24c1027ea0f22d7e71b516dcd7d5 (diff) |
Ensure global type instances are available.
Diffstat (limited to 'js')
-rw-r--r-- | js/compiler.ts | 3 | ||||
-rw-r--r-- | js/globals.ts | 75 | ||||
-rw-r--r-- | js/headers_test.ts | 8 | ||||
-rw-r--r-- | js/main.ts | 3 | ||||
-rw-r--r-- | js/repl.ts | 4 |
5 files changed, 66 insertions, 27 deletions
diff --git a/js/compiler.ts b/js/compiler.ts index 046233442..d87309512 100644 --- a/js/compiler.ts +++ b/js/compiler.ts @@ -6,11 +6,12 @@ import { assetSourceCode } from "./assets"; import * as deno from "./deno"; import { globalEval } from "./global_eval"; import { libdeno } from "./libdeno"; -import { window } from "./globals"; import * as os from "./os"; import { RawSourceMap } from "./types"; import { assert, log, notImplemented } from "./util"; +const window = globalEval("this"); + const EOL = "\n"; const ASSETS = "$asset$"; const LIB_RUNTIME = "lib.deno_runtime.d.ts"; 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; diff --git a/js/headers_test.ts b/js/headers_test.ts index 6980c3d7e..e40efcda6 100644 --- a/js/headers_test.ts +++ b/js/headers_test.ts @@ -169,3 +169,11 @@ test(function headerSymbolIteratorSuccess() { assertEqual(value, headers.get(key)); } }); + +test(function headerTypesAvailable() { + function newHeaders(): Headers { + return new Headers(); + } + const headers = newHeaders(); + assert(headers instanceof Headers); +}); diff --git a/js/main.ts b/js/main.ts index 176f098c7..b0c7ed6d4 100644 --- a/js/main.ts +++ b/js/main.ts @@ -1,4 +1,7 @@ // Copyright 2018 the Deno authors. All rights reserved. MIT license. +// We need to make sure this module loads, for its side effects. +import "./globals"; + import * as flatbuffers from "./flatbuffers"; import * as msg from "gen/msg_generated"; import { assert, log, setLogDebug } from "./util"; diff --git a/js/repl.ts b/js/repl.ts index 3139330f6..ae457e8e4 100644 --- a/js/repl.ts +++ b/js/repl.ts @@ -6,7 +6,9 @@ import * as deno from "./deno"; import { close } from "./files"; import * as dispatch from "./dispatch"; import { exit } from "./os"; -import { window } from "./globals"; +import { globalEval } from "./global_eval"; + +const window = globalEval("this"); function startRepl(historyFile: string): number { const builder = flatbuffers.createBuilder(); |