@xylabs/url 5.0.84 → 5.0.86

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -33
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -15,6 +15,8 @@
15
15
 
16
16
  Base functionality used throughout XY Labs TypeScript/JavaScript libraries
17
17
 
18
+
19
+
18
20
  ## Reference
19
21
 
20
22
  **@xylabs/url**
@@ -23,9 +25,11 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
23
25
 
24
26
  ## Modules
25
27
 
26
- - [index-browser](#index-browser/README)
27
- - [index-neutral](#index-neutral/README)
28
- - [index-node](#index-node/README)
28
+ | Module | Description |
29
+ | ------ | ------ |
30
+ | [index-browser](#index-browser/README) | - |
31
+ | [index-neutral](#index-neutral/README) | - |
32
+ | [index-node](#index-node/README) | - |
29
33
 
30
34
  ### index-browser
31
35
 
@@ -38,18 +42,16 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
38
42
  ***
39
43
 
40
44
  ```ts
41
- function isLocalhost(hostname): boolean;
45
+ function isLocalhost(hostname: string): boolean;
42
46
  ```
43
47
 
44
48
  Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).
45
49
 
46
50
  ## Parameters
47
51
 
48
- ### hostname
49
-
50
- `string`
51
-
52
- The hostname to check
52
+ | Parameter | Type | Description |
53
+ | ------ | ------ | ------ |
54
+ | `hostname` | `string` | The hostname to check |
53
55
 
54
56
  ## Returns
55
57
 
@@ -66,20 +68,17 @@ The hostname to check
66
68
  ***
67
69
 
68
70
  ```ts
69
- const URL: (url, base?) => URL;
71
+ const URL: (url: string | URL, base?: string | URL) => URL;
70
72
  ```
71
73
 
72
74
  Browser-specific URL class, aliased from the global `URL`.
73
75
 
74
76
  ## Parameters
75
77
 
76
- ### url
77
-
78
- `string` | `URL`
79
-
80
- ### base?
81
-
82
- `string` | `URL`
78
+ | Parameter | Type |
79
+ | ------ | ------ |
80
+ | `url` | `string` \| `URL` |
81
+ | `base?` | `string` \| `URL` |
83
82
 
84
83
  ## Returns
85
84
 
@@ -96,20 +95,17 @@ Browser-specific URL class, aliased from the global `URL`.
96
95
  ***
97
96
 
98
97
  ```ts
99
- const URL: (url, base?) => URL;
98
+ const URL: (url: string | URL, base?: string | URL) => URL;
100
99
  ```
101
100
 
102
101
  Platform-neutral URL class, aliased from the global `URL`.
103
102
 
104
103
  ## Parameters
105
104
 
106
- ### url
107
-
108
- `string` | `URL`
109
-
110
- ### base?
111
-
112
- `string` | `URL`
105
+ | Parameter | Type |
106
+ | ------ | ------ |
107
+ | `url` | `string` \| `URL` |
108
+ | `base?` | `string` \| `URL` |
113
109
 
114
110
  ## Returns
115
111
 
@@ -126,20 +122,17 @@ Platform-neutral URL class, aliased from the global `URL`.
126
122
  ***
127
123
 
128
124
  ```ts
129
- const URL: (url, base?) => URL;
125
+ const URL: (url: string | URL, base?: string | URL) => URL;
130
126
  ```
131
127
 
132
128
  Node.js-specific URL class, imported from the `node:url` module.
133
129
 
134
130
  ## Parameters
135
131
 
136
- ### url
137
-
138
- `string` | `URL`
139
-
140
- ### base?
141
-
142
- `string` | `URL`
132
+ | Parameter | Type |
133
+ | ------ | ------ |
134
+ | `url` | `string` \| `URL` |
135
+ | `base?` | `string` \| `URL` |
143
136
 
144
137
  ## Returns
145
138
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/url",
3
- "version": "5.0.84",
3
+ "version": "5.0.86",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "url",
@@ -53,8 +53,8 @@
53
53
  ],
54
54
  "devDependencies": {
55
55
  "@types/node": "~25.4.0",
56
- "@xylabs/ts-scripts-yarn3": "~7.4.13",
57
- "@xylabs/tsconfig": "~7.4.13",
56
+ "@xylabs/ts-scripts-yarn3": "~7.4.16",
57
+ "@xylabs/tsconfig": "~7.4.16",
58
58
  "typescript": "~5.9.3",
59
59
  "vitest": "~4.0.18"
60
60
  },