@wordpress/dom-ready 4.37.1-next.79a2f3cdd.0 → 4.37.1-next.ba3aee3a2.0

package/README.md

@@ -32,11 +32,7 @@ domReady( function () {
 
 _Parameters_
 
--   _callback_ `Callback`: A function to execute after the DOM is ready.
-
-_Returns_
-
--   `void`:
+-   _callback_ `VoidFunction`: A function to execute after the DOM is ready.
 
 <!-- END TOKEN(Autogenerated API docs) -->
 

package/build/index.cjs

@@ -17,7 +17,7 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/dom-ready/src/index.js
+// packages/dom-ready/src/index.ts
 var index_exports = {};
 __export(index_exports, {
   default: () => domReady

package/build/index.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../src/index.js"],
-  "sourcesContent": ["/**\n * @typedef {() => void} Callback\n *\n * TODO: Remove this typedef and inline `() => void` type.\n *\n * This typedef is used so that a descriptive type is provided in our\n * automatically generated documentation.\n *\n * An in-line type `() => void` would be preferable, but the generated\n * documentation is `null` in that case.\n *\n * @see https://github.com/WordPress/gutenberg/issues/18045\n */\n\n/**\n * Specify a function to execute when the DOM is fully loaded.\n *\n * @param {Callback} callback A function to execute after the DOM is ready.\n *\n * @example\n * ```js\n * import domReady from '@wordpress/dom-ready';\n *\n * domReady( function() {\n * \t//do something after DOM loads.\n * } );\n * ```\n *\n * @return {void}\n */\nexport default function domReady( callback ) {\n\tif ( typeof document === 'undefined' ) {\n\t\treturn;\n\t}\n\n\tif (\n\t\tdocument.readyState === 'complete' || // DOMContentLoaded + Images/Styles/etc loaded, so we call directly.\n\t\tdocument.readyState === 'interactive' // DOMContentLoaded fires at this point, so we call directly.\n\t) {\n\t\treturn void callback();\n\t}\n\n\t// DOMContentLoaded has not fired yet, delay callback until then.\n\tdocument.addEventListener( 'DOMContentLoaded', callback );\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA8Be,SAAR,SAA2B,UAAW;AAC5C,MAAK,OAAO,aAAa,aAAc;AACtC;AAAA,EACD;AAEA,MACC,SAAS,eAAe;AAAA,EACxB,SAAS,eAAe,eACvB;AACD,WAAO,KAAK,SAAS;AAAA,EACtB;AAGA,WAAS,iBAAkB,oBAAoB,QAAS;AACzD;",
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["/**\n * Specify a function to execute when the DOM is fully loaded.\n *\n * @param callback A function to execute after the DOM is ready.\n *\n * @example\n * ```js\n * import domReady from '@wordpress/dom-ready';\n *\n * domReady( function() {\n * \t//do something after DOM loads.\n * } );\n * ```\n */\nexport default function domReady( callback: VoidFunction ) {\n\tif ( typeof document === 'undefined' ) {\n\t\treturn;\n\t}\n\n\tif (\n\t\tdocument.readyState === 'complete' || // DOMContentLoaded + Images/Styles/etc loaded, so we call directly.\n\t\tdocument.readyState === 'interactive' // DOMContentLoaded fires at this point, so we call directly.\n\t) {\n\t\treturn void callback();\n\t}\n\n\t// DOMContentLoaded has not fired yet, delay callback until then.\n\tdocument.addEventListener( 'DOMContentLoaded', callback );\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAce,SAAR,SAA2B,UAAyB;AAC1D,MAAK,OAAO,aAAa,aAAc;AACtC;AAAA,EACD;AAEA,MACC,SAAS,eAAe;AAAA,EACxB,SAAS,eAAe,eACvB;AACD,WAAO,KAAK,SAAS;AAAA,EACtB;AAGA,WAAS,iBAAkB,oBAAoB,QAAS;AACzD;",
   "names": []
 }

package/build-module/index.mjs

@@ -1,4 +1,4 @@
-// packages/dom-ready/src/index.js
+// packages/dom-ready/src/index.ts
 function domReady(callback) {
   if (typeof document === "undefined") {
     return;

package/build-module/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../src/index.js"],
-  "sourcesContent": ["/**\n * @typedef {() => void} Callback\n *\n * TODO: Remove this typedef and inline `() => void` type.\n *\n * This typedef is used so that a descriptive type is provided in our\n * automatically generated documentation.\n *\n * An in-line type `() => void` would be preferable, but the generated\n * documentation is `null` in that case.\n *\n * @see https://github.com/WordPress/gutenberg/issues/18045\n */\n\n/**\n * Specify a function to execute when the DOM is fully loaded.\n *\n * @param {Callback} callback A function to execute after the DOM is ready.\n *\n * @example\n * ```js\n * import domReady from '@wordpress/dom-ready';\n *\n * domReady( function() {\n * \t//do something after DOM loads.\n * } );\n * ```\n *\n * @return {void}\n */\nexport default function domReady( callback ) {\n\tif ( typeof document === 'undefined' ) {\n\t\treturn;\n\t}\n\n\tif (\n\t\tdocument.readyState === 'complete' || // DOMContentLoaded + Images/Styles/etc loaded, so we call directly.\n\t\tdocument.readyState === 'interactive' // DOMContentLoaded fires at this point, so we call directly.\n\t) {\n\t\treturn void callback();\n\t}\n\n\t// DOMContentLoaded has not fired yet, delay callback until then.\n\tdocument.addEventListener( 'DOMContentLoaded', callback );\n}\n"],
-  "mappings": ";AA8Be,SAAR,SAA2B,UAAW;AAC5C,MAAK,OAAO,aAAa,aAAc;AACtC;AAAA,EACD;AAEA,MACC,SAAS,eAAe;AAAA,EACxB,SAAS,eAAe,eACvB;AACD,WAAO,KAAK,SAAS;AAAA,EACtB;AAGA,WAAS,iBAAkB,oBAAoB,QAAS;AACzD;",
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["/**\n * Specify a function to execute when the DOM is fully loaded.\n *\n * @param callback A function to execute after the DOM is ready.\n *\n * @example\n * ```js\n * import domReady from '@wordpress/dom-ready';\n *\n * domReady( function() {\n * \t//do something after DOM loads.\n * } );\n * ```\n */\nexport default function domReady( callback: VoidFunction ) {\n\tif ( typeof document === 'undefined' ) {\n\t\treturn;\n\t}\n\n\tif (\n\t\tdocument.readyState === 'complete' || // DOMContentLoaded + Images/Styles/etc loaded, so we call directly.\n\t\tdocument.readyState === 'interactive' // DOMContentLoaded fires at this point, so we call directly.\n\t) {\n\t\treturn void callback();\n\t}\n\n\t// DOMContentLoaded has not fired yet, delay callback until then.\n\tdocument.addEventListener( 'DOMContentLoaded', callback );\n}\n"],
+  "mappings": ";AAce,SAAR,SAA2B,UAAyB;AAC1D,MAAK,OAAO,aAAa,aAAc;AACtC;AAAA,EACD;AAEA,MACC,SAAS,eAAe;AAAA,EACxB,SAAS,eAAe,eACvB;AACD,WAAO,KAAK,SAAS;AAAA,EACtB;AAGA,WAAS,iBAAkB,oBAAoB,QAAS;AACzD;",
   "names": []
 }

package/build-types/index.d.ts

@@ -1,20 +1,7 @@
-/**
- * @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 {Callback} callback A function to execute after the DOM is ready.
+ * @param callback A function to execute after the DOM is ready.
  *
  * @example
  * ```js
@@ -24,18 +11,6 @@
  * 	//do something after DOM loads.
  * } );
  * ```
- *
- * @return {void}
- */
-export default function domReady(callback: Callback): void;
-/**
- * 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.
  */
-export type Callback = () => void;
+export default function domReady(callback: VoidFunction): undefined;
 //# sourceMappingURL=index.d.ts.map

package/build-types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,2CAbW,QAAQ,GAWP,IAAI,CAgBf;;;;;;;;;;uBA3CY,MAAM,IAAI"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAE,QAAQ,EAAE,YAAY,aAcvD"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/dom-ready",
-	"version": "4.37.1-next.79a2f3cdd.0",
+	"version": "4.37.1-next.ba3aee3a2.0",
 	"description": "Execute callback after the DOM is loaded.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -47,5 +47,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "6a324496a37d9a333a11d4d7fe5fb93b8152a5ba"
+	"gitHead": "67d2e486fcd40c753591cf911ca0659132f519ca"
 }

package/src/{index.js → index.ts}

@@ -1,21 +1,7 @@
-/**
- * @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 {Callback} callback A function to execute after the DOM is ready.
+ * @param callback A function to execute after the DOM is ready.
  *
  * @example
  * ```js
@@ -25,10 +11,8 @@
  * 	//do something after DOM loads.
  * } );
  * ```
- *
- * @return {void}
  */
-export default function domReady( callback ) {
+export default function domReady( callback: VoidFunction ) {
 	if ( typeof document === 'undefined' ) {
 		return;
 	}

package/src/test/{index.test.js → index.test.ts}

@@ -14,6 +14,7 @@ describe( 'domReady', () => {
 	describe( 'when document readystate is complete', () => {
 		it( 'should call the callback.', () => {
 			const callback = jest.fn( () => {} );
+			// @ts-expect-error document.readyState is read-only
 			document.readyState = 'complete';
 			domReady( callback );
 			expect( callback ).toHaveBeenCalled();
@@ -23,6 +24,7 @@ describe( 'domReady', () => {
 	describe( 'when document readystate is interactive', () => {
 		it( 'should call the callback.', () => {
 			const callback = jest.fn( () => {} );
+			// @ts-expect-error document.readyState is read-only
 			document.readyState = 'interactive';
 			domReady( callback );
 			expect( callback ).toHaveBeenCalled();
@@ -32,6 +34,7 @@ describe( 'domReady', () => {
 	describe( 'when document readystate is still loading', () => {
 		it( 'should add the callback as an event listener to the DOMContentLoaded event.', () => {
 			const addEventListener = jest.fn( () => {} );
+			// @ts-expect-error document.readyState is read-only
 			document.readyState = 'loading';
 			Object.defineProperty( document, 'addEventListener', {
 				value: addEventListener,