@wordpress/url 4.26.1-next.719a03cbe.0 → 4.27.0

package/build-types/is-valid-fragment.d.ts

@@ -1,7 +1,7 @@
 /**
  * Checks for invalid characters within the provided fragment.
  *
- * @param {string} fragment The url fragment.
+ * @param fragment The url fragment.
  *
  * @example
  * ```js
@@ -9,7 +9,7 @@
  * const isNotValid = isValidFragment( '#invalid-#fragment' ); // false
  * ```
  *
- * @return {boolean} True if the argument contains a valid fragment.
+ * @return True if the argument contains a valid fragment.
  */
-export function isValidFragment(fragment: string): boolean;
+export declare function isValidFragment(fragment: string): boolean;
 //# sourceMappingURL=is-valid-fragment.d.ts.map

package/build-types/is-valid-fragment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-valid-fragment.d.ts","sourceRoot":"","sources":["../src/is-valid-fragment.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,0CAVW,MAAM,GAQL,OAAO,CAOlB"}
+{"version":3,"file":"is-valid-fragment.d.ts","sourceRoot":"","sources":["../src/is-valid-fragment.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAE,QAAQ,EAAE,MAAM,GAAI,OAAO,CAK3D"}

package/build-types/is-valid-path.d.ts

@@ -1,7 +1,7 @@
 /**
  * Checks for invalid characters within the provided path.
  *
- * @param {string} path The URL path.
+ * @param path The URL path.
  *
  * @example
  * ```js
@@ -9,7 +9,7 @@
  * const isNotValid = isValidPath( '/invalid?test/path/' ); // false
  * ```
  *
- * @return {boolean} True if the argument contains a valid path
+ * @return True if the argument contains a valid path
  */
-export function isValidPath(path: string): boolean;
+export declare function isValidPath(path: string): boolean;
 //# sourceMappingURL=is-valid-path.d.ts.map

package/build-types/is-valid-path.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-valid-path.d.ts","sourceRoot":"","sources":["../src/is-valid-path.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,kCAVW,MAAM,GAQL,OAAO,CAOlB"}
+{"version":3,"file":"is-valid-path.d.ts","sourceRoot":"","sources":["../src/is-valid-path.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,MAAM,GAAI,OAAO,CAKnD"}

package/build-types/is-valid-protocol.d.ts

@@ -1,7 +1,7 @@
 /**
  * Tests if a url protocol is valid.
  *
- * @param {string} protocol The url protocol.
+ * @param protocol The url protocol.
  *
  * @example
  * ```js
@@ -9,7 +9,7 @@
  * const isNotValid = isValidProtocol( 'https :' ); // false
  * ```
  *
- * @return {boolean} True if the argument is a valid protocol (e.g. http:, tel:).
+ * @return True if the argument is a valid protocol (e.g. http:, tel:).
  */
-export function isValidProtocol(protocol: string): boolean;
+export declare function isValidProtocol(protocol: string): boolean;
 //# sourceMappingURL=is-valid-protocol.d.ts.map

package/build-types/is-valid-protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-valid-protocol.d.ts","sourceRoot":"","sources":["../src/is-valid-protocol.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,0CAVW,MAAM,GAQL,OAAO,CAOlB"}
+{"version":3,"file":"is-valid-protocol.d.ts","sourceRoot":"","sources":["../src/is-valid-protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAE,QAAQ,EAAE,MAAM,GAAI,OAAO,CAK3D"}

package/build-types/is-valid-query-string.d.ts

@@ -1,7 +1,7 @@
 /**
  * Checks for invalid characters within the provided query string.
  *
- * @param {string} queryString The query string.
+ * @param queryString The query string.
  *
  * @example
  * ```js
@@ -9,7 +9,7 @@
  * const isNotValid = isValidQueryString( 'query=true?another=false' ); // false
  * ```
  *
- * @return {boolean} True if the argument contains a valid query string.
+ * @return True if the argument contains a valid query string.
  */
-export function isValidQueryString(queryString: string): boolean;
+export declare function isValidQueryString(queryString: string): boolean;
 //# sourceMappingURL=is-valid-query-string.d.ts.map

package/build-types/is-valid-query-string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-valid-query-string.d.ts","sourceRoot":"","sources":["../src/is-valid-query-string.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,gDAVW,MAAM,GAQL,OAAO,CAOlB"}
+{"version":3,"file":"is-valid-query-string.d.ts","sourceRoot":"","sources":["../src/is-valid-query-string.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAE,WAAW,EAAE,MAAM,GAAI,OAAO,CAKjE"}

package/build-types/normalize-path.d.ts

@@ -3,9 +3,9 @@
  * will be treated as identical, regardless of order they appear in the original
  * text.
  *
- * @param {string} path Original path.
+ * @param path Original path.
  *
- * @return {string} Normalized path.
+ * @return Normalized path.
  */
-export function normalizePath(path: string): string;
+export declare function normalizePath(path: string): string;
 //# sourceMappingURL=normalize-path.d.ts.map

package/build-types/normalize-path.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalize-path.d.ts","sourceRoot":"","sources":["../src/normalize-path.js"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,oCAJW,MAAM,GAEL,MAAM,CA8BjB"}
+{"version":3,"file":"normalize-path.d.ts","sourceRoot":"","sources":["../src/normalize-path.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAE,IAAI,EAAE,MAAM,GAAI,MAAM,CA4BpD"}

package/build-types/prepend-http.d.ts

@@ -1,14 +1,14 @@
 /**
  * Prepends "http://" to a url, if it looks like something that is meant to be a TLD.
  *
- * @param {string} url The URL to test.
+ * @param url The URL to test.
  *
  * @example
  * ```js
  * const actualURL = prependHTTP( 'wordpress.org' ); // http://wordpress.org
  * ```
  *
- * @return {string} The updated URL.
+ * @return The updated URL.
  */
-export function prependHTTP(url: string): string;
+export declare function prependHTTP(url: string): string;
 //# sourceMappingURL=prepend-http.d.ts.map

package/build-types/prepend-http.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prepend-http.d.ts","sourceRoot":"","sources":["../src/prepend-http.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;GAWG;AACH,iCATW,MAAM,GAOL,MAAM,CAajB"}
+{"version":3,"file":"prepend-http.d.ts","sourceRoot":"","sources":["../src/prepend-http.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAE,GAAG,EAAE,MAAM,GAAI,MAAM,CAWjD"}

package/build-types/prepend-https.d.ts

@@ -3,14 +3,14 @@
  *
  * Note: this will not replace "http://" with "https://".
  *
- * @param {string} url The URL to test.
+ * @param url The URL to test.
  *
  * @example
  * ```js
  * const actualURL = prependHTTPS( 'wordpress.org' ); // https://wordpress.org
  * ```
  *
- * @return {string} The updated URL.
+ * @return The updated URL.
  */
-export function prependHTTPS(url: string): string;
+export declare function prependHTTPS(url: string): string;
 //# sourceMappingURL=prepend-https.d.ts.map

package/build-types/prepend-https.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prepend-https.d.ts","sourceRoot":"","sources":["../src/prepend-https.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,kCATW,MAAM,GAOL,MAAM,CAejB"}
+{"version":3,"file":"prepend-https.d.ts","sourceRoot":"","sources":["../src/prepend-https.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAE,GAAG,EAAE,MAAM,GAAI,MAAM,CAalD"}

package/build-types/remove-query-args.d.ts

@@ -1,15 +1,15 @@
 /**
  * Removes arguments from the query string of the url
  *
- * @param {string}    url  URL.
- * @param {...string} args Query Args.
+ * @param url  URL.
+ * @param args Query Args.
  *
  * @example
  * ```js
  * const newUrl = removeQueryArgs( 'https://wordpress.org?foo=bar&bar=baz&baz=foobar', 'foo', 'bar' ); // https://wordpress.org?baz=foobar
  * ```
  *
- * @return {string} Updated URL.
+ * @return Updated URL.
  */
-export function removeQueryArgs(url: string, ...args: string[]): string;
+export declare function removeQueryArgs(url: string, ...args: string[]): string;
 //# sourceMappingURL=remove-query-args.d.ts.map

package/build-types/remove-query-args.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remove-query-args.d.ts","sourceRoot":"","sources":["../src/remove-query-args.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;GAYG;AACH,qCAVW,MAAM,WACH,MAAM,EAAA,GAOR,MAAM,CAiBjB"}
+{"version":3,"file":"remove-query-args.d.ts","sourceRoot":"","sources":["../src/remove-query-args.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAI,MAAM,CAexE"}

package/build-types/safe-decode-uri-component.d.ts

@@ -2,9 +2,9 @@
  * Safely decodes a URI component with `decodeURIComponent`. Returns the URI component unmodified if
  * `decodeURIComponent` throws an error.
  *
- * @param {string} uriComponent URI component to decode.
+ * @param uriComponent URI component to decode.
  *
- * @return {string} Decoded URI component if possible.
+ * @return Decoded URI component if possible.
  */
-export function safeDecodeURIComponent(uriComponent: string): string;
+export declare function safeDecodeURIComponent(uriComponent: string): string;
 //# sourceMappingURL=safe-decode-uri-component.d.ts.map

package/build-types/safe-decode-uri-component.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-decode-uri-component.d.ts","sourceRoot":"","sources":["../src/safe-decode-uri-component.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,qDAJW,MAAM,GAEL,MAAM,CAQjB"}
+{"version":3,"file":"safe-decode-uri-component.d.ts","sourceRoot":"","sources":["../src/safe-decode-uri-component.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAE,YAAY,EAAE,MAAM,GAAI,MAAM,CAMrE"}

package/build-types/safe-decode-uri.d.ts

@@ -2,14 +2,14 @@
  * Safely decodes a URI with `decodeURI`. Returns the URI unmodified if
  * `decodeURI` throws an error.
  *
- * @param {string} uri URI to decode.
+ * @param uri URI to decode.
  *
  * @example
  * ```js
  * const badUri = safeDecodeURI( '%z' ); // does not throw an Error, simply returns '%z'
  * ```
  *
- * @return {string} Decoded URI if possible.
+ * @return Decoded URI if possible.
  */
-export function safeDecodeURI(uri: string): string;
+export declare function safeDecodeURI(uri: string): string;
 //# sourceMappingURL=safe-decode-uri.d.ts.map

package/build-types/safe-decode-uri.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-decode-uri.d.ts","sourceRoot":"","sources":["../src/safe-decode-uri.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,mCATW,MAAM,GAOL,MAAM,CAQjB"}
+{"version":3,"file":"safe-decode-uri.d.ts","sourceRoot":"","sources":["../src/safe-decode-uri.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAE,GAAG,EAAE,MAAM,GAAI,MAAM,CAMnD"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/url",
-	"version": "4.26.1-next.719a03cbe.0",
+	"version": "4.27.0",
 	"description": "WordPress URL utilities.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -35,5 +35,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "5e146e949c2765411a8310bcc2641a88d036a6d9"
+	"gitHead": "abe06a6f2aef8d03c30ea9d5b3e133f041e523b1"
 }

package/src/{add-query-args.js → add-query-args.ts}

@@ -10,18 +10,21 @@ import { getFragment } from './get-fragment';
  * includes query arguments, the arguments are merged with (and take precedent
  * over) the existing set.
  *
- * @param {string} [url=''] URL to which arguments should be appended. If omitted,
- *                          only the resulting querystring is returned.
- * @param {Object} [args]   Query arguments to apply to URL.
+ * @param url  URL to which arguments should be appended. If omitted,
+ *             only the resulting querystring is returned.
+ * @param args Query arguments to apply to URL.
  *
  * @example
  * ```js
  * const newURL = addQueryArgs( 'https://google.com', { q: 'test' } ); // https://google.com/?q=test
  * ```
  *
- * @return {string} URL with arguments applied.
+ * @return URL with arguments applied.
  */
-export function addQueryArgs( url = '', args ) {
+export function addQueryArgs(
+	url: string = '',
+	args?: Record< string, unknown >
+): string {
 	// If no arguments are to be appended, return original URL.
 	if ( ! args || ! Object.keys( args ).length ) {
 		return url;

package/src/{build-query-string.js → build-query-string.ts}

@@ -18,14 +18,14 @@
  * // "simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes"
  * ```
  *
- * @param {Record<string,*>} data Data to encode.
+ * @param data Data to encode.
  *
- * @return {string} Query string.
+ * @return Query string.
  */
-export function buildQueryString( data ) {
+export function buildQueryString( data: Record< string, unknown > ): string {
 	let string = '';
 
-	const stack = Object.entries( data );
+	const stack: Array< [ string, unknown ] > = Object.entries( data );
 
 	let pair;
 	while ( ( pair = stack.shift() ) ) {
@@ -39,7 +39,7 @@ export function buildQueryString( data ) {
 			// Push array or object values onto the stack as composed of their
 			// original key and nested index or key, retaining order by a
 			// combination of Array#reverse and Array#unshift onto the stack.
-			const valuePairs = Object.entries( value ).reverse();
+			const valuePairs = Object.entries( value as object ).reverse();
 			for ( const [ member, memberValue ] of valuePairs ) {
 				stack.unshift( [ `${ key }[${ member }]`, memberValue ] );
 			}
@@ -50,7 +50,8 @@ export function buildQueryString( data ) {
 			}
 
 			string +=
-				'&' + [ key, value ].map( encodeURIComponent ).join( '=' );
+				'&' +
+				[ key, String( value ) ].map( encodeURIComponent ).join( '=' );
 		}
 	}
 

package/src/{clean-for-slug.js → clean-for-slug.ts}

@@ -15,11 +15,11 @@ import removeAccents from 'remove-accents';
  * except hyphens. Converts remaining string to lowercase. It does not account
  * for octets, HTML entities, or other encoded characters.
  *
- * @param {string} string Title or slug to be processed.
+ * @param string Title or slug to be processed.
  *
- * @return {string} Processed string.
+ * @return Processed string.
  */
-export function cleanForSlug( string ) {
+export function cleanForSlug( string: string ): string {
 	if ( ! string ) {
 		return '';
 	}

package/src/{filter-url-for-display.js → filter-url-for-display.ts}

@@ -1,8 +1,8 @@
 /**
  * Returns a URL for display.
  *
- * @param {string}      url       Original URL.
- * @param {number|null} maxLength URL length.
+ * @param url       Original URL.
+ * @param maxLength URL length.
  *
  * @example
  * ```js
@@ -10,9 +10,12 @@
  * const imageUrl = filterURLForDisplay( 'https://www.wordpress.org/wp-content/uploads/img.png', 20 ); // …ent/uploads/img.png
  * ```
  *
- * @return {string} Displayed URL.
+ * @return Displayed URL.
  */
-export function filterURLForDisplay( url, maxLength = null ) {
+export function filterURLForDisplay(
+	url: string,
+	maxLength: number | null = null
+): string {
 	if ( ! url ) {
 		return '';
 	}

package/src/{get-authority.js → get-authority.ts}

@@ -1,7 +1,7 @@
 /**
  * Returns the authority part of the URL.
  *
- * @param {string} url The full URL.
+ * @param url The full URL.
  *
  * @example
  * ```js
@@ -9,9 +9,9 @@
  * const authority2 = getAuthority( 'https://localhost:8080/test/' ); // 'localhost:8080'
  * ```
  *
- * @return {string|void} The authority part of the URL.
+ * @return The authority part of the URL.
  */
-export function getAuthority( url ) {
+export function getAuthority( url: string ): string | void {
 	const matches = /^[^\/\s:]+:(?:\/\/)?\/?([^\/\s#?]+)[\/#?]{0,1}\S*$/.exec(
 		url
 	);

package/src/{get-filename.js → get-filename.ts}

@@ -1,7 +1,7 @@
 /**
  * Returns the filename part of the URL.
  *
- * @param {string} url The full URL.
+ * @param url The full URL.
  *
  * @example
  * ```js
@@ -9,9 +9,9 @@
  * const filename2 = getFilename( '/this/is/a/test.png' ); // 'test.png'
  * ```
  *
- * @return {string|void} The filename part of the URL.
+ * @return The filename part of the URL.
  */
-export function getFilename( url ) {
+export function getFilename( url: string ): string | void {
 	let filename;
 
 	if ( ! url ) {

package/src/{get-fragment.js → get-fragment.ts}

@@ -1,7 +1,7 @@
 /**
  * Returns the fragment part of the URL.
  *
- * @param {string} url The full URL
+ * @param url The full URL
  *
  * @example
  * ```js
@@ -9,9 +9,9 @@
  * const fragment2 = getFragment( 'https://wordpress.org#another-fragment?query=true' ); // '#another-fragment'
  * ```
  *
- * @return {string|void} The fragment part of the URL.
+ * @return The fragment part of the URL.
  */
-export function getFragment( url ) {
+export function getFragment( url: string ): string | void {
 	const matches = /^\S+?(#[^\s\?]*)/.exec( url );
 	if ( matches ) {
 		return matches[ 1 ];

package/src/{get-path-and-query-string.js → get-path-and-query-string.ts}

@@ -6,7 +6,7 @@ import { getPath, getQueryString } from '.';
 /**
  * Returns the path part and query string part of the URL.
  *
- * @param {string} url The full URL.
+ * @param url The full URL.
  *
  * @example
  * ```js
@@ -14,9 +14,9 @@ import { getPath, getQueryString } from '.';
  * const pathAndQueryString2 = getPathAndQueryString( 'https://wordpress.org/help/faq/' ); // '/help/faq'
  * ```
  *
- * @return {string} The path part and query string part of the URL.
+ * @return The path part and query string part of the URL.
  */
-export function getPathAndQueryString( url ) {
+export function getPathAndQueryString( url: string ): string {
 	const path = getPath( url );
 	const queryString = getQueryString( url );
 	let value = '/';

package/src/{get-path.js → get-path.ts}

@@ -1,7 +1,7 @@
 /**
  * Returns the path part of the URL.
  *
- * @param {string} url The full URL.
+ * @param url The full URL.
  *
  * @example
  * ```js
@@ -9,9 +9,9 @@
  * const path2 = getPath( 'https://wordpress.org/help/faq/' ); // 'help/faq'
  * ```
  *
- * @return {string|void} The path part of the URL.
+ * @return The path part of the URL.
  */
-export function getPath( url ) {
+export function getPath( url: string ): string | void {
 	const matches =
 		/^[^\/\s:]+:(?:\/\/)?[^\/\s#?]+[\/]([^\s#?]+)[#?]{0,1}\S*$/.exec( url );
 	if ( matches ) {

package/src/{get-protocol.js → get-protocol.ts}

@@ -1,7 +1,7 @@
 /**
  * Returns the protocol part of the URL.
  *
- * @param {string} url The full URL.
+ * @param url The full URL.
  *
  * @example
  * ```js
@@ -9,9 +9,9 @@
  * const protocol2 = getProtocol( 'https://wordpress.org' ); // 'https:'
  * ```
  *
- * @return {string|void} The protocol part of the URL.
+ * @return  The protocol part of the URL.
  */
-export function getProtocol( url ) {
+export function getProtocol( url: string ): string | void {
 	const matches = /^([^\s:]+:)/.exec( url );
 	if ( matches ) {
 		return matches[ 1 ];

package/src/get-query-arg.ts

@@ -0,0 +1,30 @@
+/**
+ * Internal dependencies
+ */
+import { getQueryArgs } from './get-query-args';
+
+export interface QueryArgObject {
+	[ key: string ]: QueryArgParsed;
+}
+
+export type QueryArgParsed = string | string[] | QueryArgObject;
+
+/**
+ * Returns a single query argument of the url
+ *
+ * @param url URL.
+ * @param arg Query arg name.
+ *
+ * @example
+ * ```js
+ * const foo = getQueryArg( 'https://wordpress.org?foo=bar&bar=baz', 'foo' ); // bar
+ * ```
+ *
+ * @return Query arg value.
+ */
+export function getQueryArg(
+	url: string,
+	arg: string
+): QueryArgParsed | undefined {
+	return getQueryArgs( url )[ arg ];
+}

package/src/{get-query-args.js → get-query-args.ts}

@@ -3,22 +3,19 @@
  */
 import { safeDecodeURIComponent } from './safe-decode-uri-component';
 import { getQueryString } from './get-query-string';
+import type { QueryArgParsed } from './get-query-arg';
 
-/** @typedef {import('./get-query-arg').QueryArgParsed} QueryArgParsed */
-
-/**
- * @typedef {Record<string,QueryArgParsed>} QueryArgs
- */
+type QueryArgs = Record< string, QueryArgParsed >;
 
 /**
  * Sets a value in object deeply by a given array of path segments. Mutates the
  * object reference.
  *
- * @param {Record<string,*>} object Object in which to assign.
- * @param {string[]}         path   Path segment at which to set value.
- * @param {*}                value  Value to set.
+ * @param object Object in which to assign.
+ * @param path   Path segment at which to set value.
+ * @param value  Value to set.
  */
-function setPath( object, path, value ) {
+function setPath( object: Record< string, any >, path: string[], value: any ) {
 	const length = path.length;
 	const lastIndex = length - 1;
 	for ( let i = 0; i < length; i++ ) {
@@ -61,7 +58,7 @@ function setPath( object, path, value ) {
  * Returns an object of query arguments of the given URL. If the given URL is
  * invalid or has no querystring, an empty object is returned.
  *
- * @param {string} url URL.
+ * @param url URL.
  *
  * @example
  * ```js
@@ -69,9 +66,9 @@ function setPath( object, path, value ) {
  * // { "foo": "bar", "bar": "baz" }
  * ```
  *
- * @return {QueryArgs} Query args object.
+ * @return Query args object.
  */
-export function getQueryArgs( url ) {
+export function getQueryArgs( url: string ): QueryArgs {
 	return (
 		( getQueryString( url ) || '' )
 			// Normalize space encoding, accounting for PHP URL encoding

package/src/{get-query-string.js → get-query-string.ts}

@@ -1,16 +1,16 @@
 /**
  * Returns the query string part of the URL.
  *
- * @param {string} url The full URL.
+ * @param url The full URL.
  *
  * @example
  * ```js
  * const queryString = getQueryString( 'http://localhost:8080/this/is/a/test?query=true#fragment' ); // 'query=true'
  * ```
  *
- * @return {string|void} The query string part of the URL.
+ * @return The query string part of the URL.
  */
-export function getQueryString( url ) {
+export function getQueryString( url: string ): string | void {
 	let query;
 	try {
 		query = new URL( url, 'http://example.com' ).search.substring( 1 );

package/src/{has-query-arg.js → has-query-arg.ts}

@@ -6,16 +6,16 @@ import { getQueryArg } from './get-query-arg';
 /**
  * Determines whether the URL contains a given query arg.
  *
- * @param {string} url URL.
- * @param {string} arg Query arg name.
+ * @param url URL.
+ * @param arg Query arg name.
  *
  * @example
  * ```js
  * const hasBar = hasQueryArg( 'https://wordpress.org?foo=bar&bar=baz', 'bar' ); // true
  * ```
  *
- * @return {boolean} Whether or not the URL contains the query arg.
+ * @return Whether or not the URL contains the query arg.
  */
-export function hasQueryArg( url, arg ) {
+export function hasQueryArg( url: string, arg: string ): boolean {
 	return getQueryArg( url, arg ) !== undefined;
 }

package/src/{is-email.js → is-email.ts}

@@ -4,15 +4,15 @@ const EMAIL_REGEXP =
 /**
  * Determines whether the given string looks like an email.
  *
- * @param {string} email The string to scrutinise.
+ * @param email The string to scrutinise.
  *
  * @example
  * ```js
  * const isEmail = isEmail( 'hello@wordpress.org' ); // true
  * ```
  *
- * @return {boolean} Whether or not it looks like an email.
+ * @return Whether or not it looks like an email.
  */
-export function isEmail( email ) {
+export function isEmail( email: string ): boolean {
 	return EMAIL_REGEXP.test( email );
 }