@xylabs/url 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/url**
@@ -23,9 +25,11 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Modules
 
-- [index-browser](#index-browser/README)
-- [index-neutral](#index-neutral/README)
-- [index-node](#index-node/README)
+| Module | Description |
+| ------ | ------ |
+| [index-browser](#index-browser/README) | - |
+| [index-neutral](#index-neutral/README) | - |
+| [index-node](#index-node/README) | - |
 
 ### index-browser
 
@@ -38,19 +42,23 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 ***
 
 ```ts
-function isLocalhost(hostname): boolean;
+function isLocalhost(hostname: string): boolean;
 ```
 
-## Parameters
+Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).
 
-### hostname
+## Parameters
 
-`string`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `hostname` | `string` | The hostname to check |
 
 ## Returns
 
 `boolean`
 
+`true` if the hostname is a localhost address
+
   ### variables
 
     ### <a id="URL"></a>URL
@@ -60,18 +68,17 @@ function isLocalhost(hostname): boolean;
 ***
 
 ```ts
-const URL: (url, base?) => URL;
+const URL: (url: string | URL, base?: string | URL) => URL;
 ```
 
-## Parameters
-
-### url
+Browser-specific URL class, aliased from the global `URL`.
 
-`string` | `URL`
-
-### base?
+## Parameters
 
-`string` | `URL`
+| Parameter | Type |
+| ------ | ------ |
+| `url` | `string` \| `URL` |
+| `base?` | `string` \| `URL` |
 
 ## Returns
 
@@ -88,18 +95,17 @@ const URL: (url, base?) => URL;
 ***
 
 ```ts
-const URL: (url, base?) => URL;
+const URL: (url: string | URL, base?: string | URL) => URL;
 ```
 
-## Parameters
-
-### url
+Platform-neutral URL class, aliased from the global `URL`.
 
-`string` | `URL`
-
-### base?
+## Parameters
 
-`string` | `URL`
+| Parameter | Type |
+| ------ | ------ |
+| `url` | `string` \| `URL` |
+| `base?` | `string` \| `URL` |
 
 ## Returns
 
@@ -116,18 +122,17 @@ const URL: (url, base?) => URL;
 ***
 
 ```ts
-const URL: (url, base?) => URL;
+const URL: (url: string | URL, base?: string | URL) => URL;
 ```
 
-## Parameters
-
-### url
+Node.js-specific URL class, imported from the `node:url` module.
 
-`string` | `URL`
-
-### base?
+## Parameters
 
-`string` | `URL`
+| Parameter | Type |
+| ------ | ------ |
+| `url` | `string` \| `URL` |
+| `base?` | `string` \| `URL` |
 
 ## Returns
 

package/dist/browser/index-browser.d.ts

@@ -1,3 +1,4 @@
+/** Browser-specific URL class, aliased from the global `URL`. */
 declare const BrowserUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/browser/index-browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AACA,iEAAiE;AACjE,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/dist/browser/index-browser.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/lib/isLocalhost.ts","../../src/index-browser.ts"],"sourcesContent":["export const isLocalhost = (hostname: string): boolean => {\n  return (\n    hostname === 'localhost'\n    || hostname === '127.0.0.1'\n    || hostname === '::1' // IPv6 localhost\n    || hostname.endsWith('.localhost')\n  )\n}\n","/// <reference lib=\"dom\" />\nconst BrowserUrl = URL\nexport { BrowserUrl as URL }\nexport * from './lib/index.ts'\n"],"mappings":";AAAO,IAAM,cAAc,CAAC,aAA8B;AACxD,SACE,aAAa,eACV,aAAa,eACb,aAAa,SACb,SAAS,SAAS,YAAY;AAErC;;;ACNA,IAAM,aAAa;","names":[]}
+{"version":3,"sources":["../../src/lib/isLocalhost.ts","../../src/index-browser.ts"],"sourcesContent":["/**\n * Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).\n * @param hostname - The hostname to check\n * @returns `true` if the hostname is a localhost address\n */\nexport const isLocalhost = (hostname: string): boolean => {\n  return (\n    hostname === 'localhost'\n    || hostname === '127.0.0.1'\n    || hostname === '::1' // IPv6 localhost\n    || hostname.endsWith('.localhost')\n  )\n}\n","/// <reference lib=\"dom\" />\n/** Browser-specific URL class, aliased from the global `URL`. */\nconst BrowserUrl = URL\nexport { BrowserUrl as URL }\nexport * from './lib/index.ts'\n"],"mappings":";AAKO,IAAM,cAAc,CAAC,aAA8B;AACxD,SACE,aAAa,eACV,aAAa,eACb,aAAa,SACb,SAAS,SAAS,YAAY;AAErC;;;ACVA,IAAM,aAAa;","names":[]}

package/dist/browser/index-neutral.d.ts

@@ -1,3 +1,4 @@
+/** Platform-neutral URL class, aliased from the global `URL`. */
 declare const NeutralUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/browser/index-neutral.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-neutral.d.ts","sourceRoot":"","sources":["../../src/index-neutral.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-neutral.d.ts","sourceRoot":"","sources":["../../src/index-neutral.ts"],"names":[],"mappings":"AACA,iEAAiE;AACjE,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/dist/browser/index-node.d.ts

@@ -1,4 +1,5 @@
 import { URL } from 'node:url';
+/** Node.js-specific URL class, imported from the `node:url` module. */
 declare const NodeUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/browser/index-node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,QAAA,MAAM,OAAO;;;;;;;CAAM,CAAA;AACnB,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,CAAA;AACzB,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,uEAAuE;AACvE,QAAA,MAAM,OAAO;;;;;;;CAAM,CAAA;AACnB,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,CAAA;AACzB,cAAc,gBAAgB,CAAA"}

package/dist/browser/lib/isLocalhost.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).
+ * @param hostname - The hostname to check
+ * @returns `true` if the hostname is a localhost address
+ */
 export declare const isLocalhost: (hostname: string) => boolean;
 //# sourceMappingURL=isLocalhost.d.ts.map

package/dist/browser/lib/isLocalhost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isLocalhost.d.ts","sourceRoot":"","sources":["../../../src/lib/isLocalhost.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,UAAU,MAAM,KAAG,OAO9C,CAAA"}
+{"version":3,"file":"isLocalhost.d.ts","sourceRoot":"","sources":["../../../src/lib/isLocalhost.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,MAAM,KAAG,OAO9C,CAAA"}

package/dist/neutral/index-browser.d.ts

@@ -1,3 +1,4 @@
+/** Browser-specific URL class, aliased from the global `URL`. */
 declare const BrowserUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/neutral/index-browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AACA,iEAAiE;AACjE,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/dist/neutral/index-neutral.d.ts

@@ -1,3 +1,4 @@
+/** Platform-neutral URL class, aliased from the global `URL`. */
 declare const NeutralUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/neutral/index-neutral.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-neutral.d.ts","sourceRoot":"","sources":["../../src/index-neutral.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-neutral.d.ts","sourceRoot":"","sources":["../../src/index-neutral.ts"],"names":[],"mappings":"AACA,iEAAiE;AACjE,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/dist/neutral/index-neutral.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/lib/isLocalhost.ts","../../src/index-neutral.ts"],"sourcesContent":["export const isLocalhost = (hostname: string): boolean => {\n  return (\n    hostname === 'localhost'\n    || hostname === '127.0.0.1'\n    || hostname === '::1' // IPv6 localhost\n    || hostname.endsWith('.localhost')\n  )\n}\n","/// <reference lib=\"dom\" />\nconst NeutralUrl = URL\nexport { NeutralUrl as URL }\nexport * from './lib/index.ts'\n"],"mappings":";AAAO,IAAM,cAAc,CAAC,aAA8B;AACxD,SACE,aAAa,eACV,aAAa,eACb,aAAa,SACb,SAAS,SAAS,YAAY;AAErC;;;ACNA,IAAM,aAAa;","names":[]}
+{"version":3,"sources":["../../src/lib/isLocalhost.ts","../../src/index-neutral.ts"],"sourcesContent":["/**\n * Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).\n * @param hostname - The hostname to check\n * @returns `true` if the hostname is a localhost address\n */\nexport const isLocalhost = (hostname: string): boolean => {\n  return (\n    hostname === 'localhost'\n    || hostname === '127.0.0.1'\n    || hostname === '::1' // IPv6 localhost\n    || hostname.endsWith('.localhost')\n  )\n}\n","/// <reference lib=\"dom\" />\n/** Platform-neutral URL class, aliased from the global `URL`. */\nconst NeutralUrl = URL\nexport { NeutralUrl as URL }\nexport * from './lib/index.ts'\n"],"mappings":";AAKO,IAAM,cAAc,CAAC,aAA8B;AACxD,SACE,aAAa,eACV,aAAa,eACb,aAAa,SACb,SAAS,SAAS,YAAY;AAErC;;;ACVA,IAAM,aAAa;","names":[]}

package/dist/neutral/index-node.d.ts

@@ -1,4 +1,5 @@
 import { URL } from 'node:url';
+/** Node.js-specific URL class, imported from the `node:url` module. */
 declare const NodeUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/neutral/index-node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,QAAA,MAAM,OAAO;;;;;;;CAAM,CAAA;AACnB,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,CAAA;AACzB,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,uEAAuE;AACvE,QAAA,MAAM,OAAO;;;;;;;CAAM,CAAA;AACnB,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,CAAA;AACzB,cAAc,gBAAgB,CAAA"}

package/dist/neutral/lib/isLocalhost.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).
+ * @param hostname - The hostname to check
+ * @returns `true` if the hostname is a localhost address
+ */
 export declare const isLocalhost: (hostname: string) => boolean;
 //# sourceMappingURL=isLocalhost.d.ts.map

package/dist/neutral/lib/isLocalhost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isLocalhost.d.ts","sourceRoot":"","sources":["../../../src/lib/isLocalhost.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,UAAU,MAAM,KAAG,OAO9C,CAAA"}
+{"version":3,"file":"isLocalhost.d.ts","sourceRoot":"","sources":["../../../src/lib/isLocalhost.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,MAAM,KAAG,OAO9C,CAAA"}

package/dist/node/index-browser.d.ts

@@ -1,3 +1,4 @@
+/** Browser-specific URL class, aliased from the global `URL`. */
 declare const BrowserUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/node/index-browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AACA,iEAAiE;AACjE,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/dist/node/index-neutral.d.ts

@@ -1,3 +1,4 @@
+/** Platform-neutral URL class, aliased from the global `URL`. */
 declare const NeutralUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/node/index-neutral.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-neutral.d.ts","sourceRoot":"","sources":["../../src/index-neutral.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-neutral.d.ts","sourceRoot":"","sources":["../../src/index-neutral.ts"],"names":[],"mappings":"AACA,iEAAiE;AACjE,QAAA,MAAM,UAAU;;;;;;;CAAM,CAAA;AACtB,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/dist/node/index-node.d.ts

@@ -1,4 +1,5 @@
 import { URL } from 'node:url';
+/** Node.js-specific URL class, imported from the `node:url` module. */
 declare const NodeUrl: {
     new (url: string | URL, base?: string | URL): URL;
     prototype: URL;

package/dist/node/index-node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,QAAA,MAAM,OAAO;;;;;;;CAAM,CAAA;AACnB,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,CAAA;AACzB,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,uEAAuE;AACvE,QAAA,MAAM,OAAO;;;;;;;CAAM,CAAA;AACnB,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,CAAA;AACzB,cAAc,gBAAgB,CAAA"}

package/dist/node/index-node.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index-node.ts","../../src/lib/isLocalhost.ts"],"sourcesContent":["import { URL } from 'node:url'\n\nconst NodeUrl = URL\nexport { NodeUrl as URL }\nexport * from './lib/index.ts'\n","export const isLocalhost = (hostname: string): boolean => {\n  return (\n    hostname === 'localhost'\n    || hostname === '127.0.0.1'\n    || hostname === '::1' // IPv6 localhost\n    || hostname.endsWith('.localhost')\n  )\n}\n"],"mappings":";AAAA,SAAS,WAAW;;;ACAb,IAAM,cAAc,CAAC,aAA8B;AACxD,SACE,aAAa,eACV,aAAa,eACb,aAAa,SACb,SAAS,SAAS,YAAY;AAErC;;;ADLA,IAAM,UAAU;","names":[]}
+{"version":3,"sources":["../../src/index-node.ts","../../src/lib/isLocalhost.ts"],"sourcesContent":["import { URL } from 'node:url'\n\n/** Node.js-specific URL class, imported from the `node:url` module. */\nconst NodeUrl = URL\nexport { NodeUrl as URL }\nexport * from './lib/index.ts'\n","/**\n * Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).\n * @param hostname - The hostname to check\n * @returns `true` if the hostname is a localhost address\n */\nexport const isLocalhost = (hostname: string): boolean => {\n  return (\n    hostname === 'localhost'\n    || hostname === '127.0.0.1'\n    || hostname === '::1' // IPv6 localhost\n    || hostname.endsWith('.localhost')\n  )\n}\n"],"mappings":";AAAA,SAAS,WAAW;;;ACKb,IAAM,cAAc,CAAC,aAA8B;AACxD,SACE,aAAa,eACV,aAAa,eACb,aAAa,SACb,SAAS,SAAS,YAAY;AAErC;;;ADTA,IAAM,UAAU;","names":[]}

package/dist/node/lib/isLocalhost.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).
+ * @param hostname - The hostname to check
+ * @returns `true` if the hostname is a localhost address
+ */
 export declare const isLocalhost: (hostname: string) => boolean;
 //# sourceMappingURL=isLocalhost.d.ts.map

package/dist/node/lib/isLocalhost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isLocalhost.d.ts","sourceRoot":"","sources":["../../../src/lib/isLocalhost.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,UAAU,MAAM,KAAG,OAO9C,CAAA"}
+{"version":3,"file":"isLocalhost.d.ts","sourceRoot":"","sources":["../../../src/lib/isLocalhost.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,MAAM,KAAG,OAO9C,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/url",
-  "version": "5.0.83",
+  "version": "5.0.86",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "url",
@@ -53,8 +53,8 @@
   ],
   "devDependencies": {
     "@types/node": "~25.4.0",
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },