Dom Ready: Add types

packages/dom-ready/README.md

@@ -32,7 +32,7 @@ domReady( function() {
 
 _Parameters_
 
--   _callback_ `Function`: A function to execute after the DOM is ready.
+-   _callback_ `Callback`: A function to execute after the DOM is ready.
 
 _Returns_
 

packages/dom-ready/src/index.js

@@ -1,7 +1,21 @@
+/**
+ * @typedef {() => void} Callback
+ *
+ * TODO: Remove this typedef and inline `() => void` type.
+ *
+ * This typedef is used so that a descriptive type is provided in our
+ * automatically generated documentation.
+ *
+ * An in-line type `() => void` would be preferable, but the generated
+ * documentation is `null` in that case.
+ *
+ * @see https://github.com/WordPress/gutenberg/issues/18045
+ */
+
 /**
  * Specify a function to execute when the DOM is fully loaded.
  *
- * @param {Function} callback A function to execute after the DOM is ready.
+ * @param {Callback} callback A function to execute after the DOM is ready.
  *
  * @example
  * ```js
@@ -14,16 +28,14 @@
  *
  * @return {void}
  */
-const domReady = function( callback ) {
+export default function domReady( callback ) {
 	if (
 		document.readyState === 'complete' || // DOMContentLoaded + Images/Styles/etc loaded, so we call directly.
 		document.readyState === 'interactive' // DOMContentLoaded fires at this point, so we call directly.
 	) {
-		return callback();
+		return void callback();
 	}
 
 	// DOMContentLoaded has not fired yet, delay callback until then.
 	document.addEventListener( 'DOMContentLoaded', callback );
-};
-
-export default domReady;
+}

tsconfig.json

@@ -19,9 +19,9 @@
 		"noUnusedParameters": true,            /* Report errors on unused parameters. */
 		"noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
 		"noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
 	},
 	"include": [
+		"./packages/dom-ready/**/*.js",
 		"./packages/i18n/**/*.js",
 		"./packages/is-shallow-equal/**/*.js",
 		"./packages/priority-queue/**/*.js",