lib: use bindingsmap for mapping types

Author: anonrig

lib/internal/bootstrap/loaders.js

@@ -160,13 +160,19 @@ const schemelessBlockList = new SafeSet([
   };
 }
 
+/**
+ * @typedef {import('../../../typings/bindings').InternalBindingMap} InternalBindingMap
+ */
 // Set up internalBinding() in the closure.
 // Do not use `internalBinding` variable name due to the breakage of TypeScript autocompletion.
-let _internalBinding;
+/**
+ * @type {<T extends keyof InternalBindingMap>(binding: T) => InternalBindingMap[T]}
+ */
+let internalBinding;
 {
   const bindingObj = { __proto__: null };
   // eslint-disable-next-line no-global-assign
-  _internalBinding = function internalBinding(module) {
+  internalBinding = function internalBinding(module) {
     let mod = bindingObj[module];
     if (typeof mod !== 'object') {
       mod = bindingObj[module] = getInternalBinding(module);
@@ -181,7 +187,7 @@ const {
   builtinIds,
   compileFunction,
   setInternalLoaders,
-} = _internalBinding('builtins');
+} = internalBinding('builtins');
 
 const getOwn = (target, property, receiver) => {
   return ObjectPrototypeHasOwnProperty(target, property) ?
@@ -279,7 +285,7 @@ class BuiltinModule {
 
   getESMFacade() {
     if (this.module) return this.module;
-    const { ModuleWrap } = _internalBinding('module_wrap');
+    const { ModuleWrap } = internalBinding('module_wrap');
     // TODO(aduh95): move this to C++, alongside the initialization of the class.
     ObjectSetPrototypeOf(ModuleWrap.prototype, null);
     const url = `node:${this.id}`;
@@ -329,7 +335,7 @@ class BuiltinModule {
       const fn = compileFunction(id);
       // Arguments must match the parameters specified in
       // BuiltinLoader::LookupAndCompile().
-      fn(this.exports, requireFn, this, process, _internalBinding, primordials);
+      fn(this.exports, requireFn, this, process, internalBinding, primordials);
 
       this.loaded = true;
     } finally {
@@ -346,7 +352,7 @@ class BuiltinModule {
 // Think of this as module.exports in this file even though it is not
 // written in CommonJS style.
 const loaderExports = {
-  internalBinding: _internalBinding,
+  internalBinding,
   BuiltinModule,
   require: requireBuiltin,
 };
@@ -373,4 +379,4 @@ function requireWithFallbackInDeps(request) {
 }
 
 // Store the internal loaders in C++.
-setInternalLoaders(_internalBinding, requireBuiltin);
+setInternalLoaders(internalBinding, requireBuiltin);

tsconfig.json

@@ -2,21 +2,7 @@
   "include": ["lib", "doc"],
   "exclude": ["src", "tools", "out"],
   "files": [
-    "./typings/internalBinding/async_wrap.d.ts",
-    "./typings/internalBinding/blob.d.ts",
-    "./typings/internalBinding/config.d.ts",
-    "./typings/internalBinding/constants.d.ts",
-    "./typings/internalBinding/fs.d.ts",
-    "./typings/internalBinding/http_parser.d.ts",
-    "./typings/internalBinding/messaging.d.ts",
-    "./typings/internalBinding/options.d.ts",
-    "./typings/internalBinding/os.d.ts",
-    "./typings/internalBinding/serdes.d.ts",
-    "./typings/internalBinding/symbols.d.ts",
-    "./typings/internalBinding/timers.d.ts",
-    "./typings/internalBinding/types.d.ts",
-    "./typings/internalBinding/util.d.ts",
-    "./typings/internalBinding/worker.d.ts",
+    "./typings/bindings.d.ts",
     "./typings/globals.d.ts",
     "./typings/primordials.d.ts"
   ],

typings/bindings.d.ts

@@ -0,0 +1,33 @@
+import type { AsyncWrapBinding } from './internalBinding/async_wrap';
+import type { BlobBinding } from "./internalBinding/blob";
+import type { ConfigBinding } from "./internalBinding/config";
+import type { ConstantsBinding } from "./internalBinding/constants";
+import type { FSBinding } from "./internalBinding/fs";
+import type { HttpParserBinding } from "./internalBinding/http_parser";
+import type { MessagingBinding } from "./internalBinding/messaging";
+import type { OptionsBinding } from "./internalBinding/options";
+import type { OSBinding } from "./internalBinding/os";
+import type { SerdesBinding } from "./internalBinding/serdes";
+import type { SymbolsBinding } from "./internalBinding/symbols";
+import type { TimersBinding } from "./internalBinding/timers";
+import type { TypesBinding } from "./internalBinding/types";
+import type { UtilBindings } from "./internalBinding/util";
+import type { WorkerBinding } from "./internalBinding/worker";
+
+export type InternalBindingMap = {
+  async_wrap: AsyncWrapBinding;
+  blob: BlobBinding;
+  config: ConfigBinding;
+  constants: ConstantsBinding;
+  fs: FSBinding;
+  http_parser: HttpParserBinding
+  messaging: MessagingBinding;
+  options: OptionsBinding;
+  os: OSBinding;
+  serdes: SerdesBinding;
+  symbols: SymbolsBinding;
+  timers: TimersBinding;
+  types: TypesBinding;
+  util: UtilBindings;
+  worker: WorkerBinding;
+}

typings/internalBinding/async_wrap.d.ts

@@ -72,7 +72,7 @@ declare namespace InternalAsyncWrapBinding {
   }
 }
 
-declare function internalBinding(binding: 'async_wrap'): {
+export type AsyncWrapBinding = {
   setupHooks(): {
     init: (
       asyncId: number,
@@ -129,4 +129,4 @@ declare function internalBinding(binding: 'async_wrap'): {
     kDefaultTriggerAsyncId: 3;
   };
   Providers: InternalAsyncWrapBinding.Providers;
-};
+}

typings/internalBinding/blob.d.ts

@@ -10,7 +10,7 @@ declare namespace InternalBlobBinding {
   }
 }
 
-declare function internalBinding(binding: 'blob'): {
+export type BlobBinding = {
   createBlob(sources: Array<Uint8Array | InternalBlobBinding.BlobHandle>, length: number): InternalBlobBinding.BlobHandle;
   FixedSizeBlobCopyJob: typeof InternalBlobBinding.FixedSizeBlobCopyJob;
   getDataObject(id: string): [handle: InternalBlobBinding.BlobHandle | undefined, length: number, type: string] | undefined;

typings/internalBinding/config.d.ts

@@ -1,4 +1,4 @@
-declare function internalBinding(binding: 'config'): {
+export type ConfigBinding = {
   isDebugBuild: boolean;
   hasOpenSSL: boolean;
   fipsMode: boolean;

typings/internalBinding/constants.d.ts

@@ -1,4 +1,4 @@
-declare function internalBinding(binding: 'constants'): {
+export type ConstantsBinding = {
   os: {
     UV_UDP_REUSEADDR: 4;
     dlopen: {

typings/internalBinding/fs.d.ts

@@ -220,7 +220,7 @@ declare namespace InternalFSBinding {
   function writeString(fd: number, value: string, pos: unknown, encoding: unknown, usePromises: typeof kUsePromises): Promise<number>;
 }
 
-declare function internalBinding(binding: 'fs'): {
+export type FSBinding = {
   FSReqCallback: typeof InternalFSBinding.FSReqCallback;
 
   FileHandle: typeof InternalFSBinding.FileHandle;

typings/internalBinding/http_parser.d.ts

@@ -39,7 +39,7 @@ declare namespace InternalHttpParserBinding {
   }
 }
 
-declare function internalBinding(binding: 'http_parser'): {
+export type HttpParserBinding = {
   methods: string[];
   HTTPParser: typeof InternalHttpParserBinding.HTTPParser;
 };

typings/internalBinding/messaging.d.ts

@@ -1,4 +1,4 @@
-import type { DOMException } from '../../lib/internal/per_context/domexception';
+import type { DOMException } from 'internal/per_context/domexception';
 
 declare namespace InternalMessagingBinding {
   class MessageChannel {
@@ -19,7 +19,7 @@ declare namespace InternalMessagingBinding {
 }
 
 
-declare function internalBinding(binding: 'messaging'): {
+export type MessagingBinding = {
   DOMException: typeof DOMException;
   MessageChannel: typeof InternalMessagingBinding.MessageChannel;
   MessagePort: typeof InternalMessagingBinding.MessagePort;