@xylabs/url 5.0.95 → 5.0.96

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 +75 -85
  2. package/package.json +6 -7
package/README.md CHANGED
@@ -1,57 +1,72 @@
1
1
  # @xylabs/url
2
2
 
3
- [![logo][]](https://xylabs.com)
3
+ [![npm][npm-badge]][npm-link]
4
+ [![license][license-badge]][license-link]
4
5
 
5
- [![main-build][]][main-build-link]
6
- [![npm-badge][]][npm-link]
7
- [![npm-downloads-badge][]][npm-link]
8
- [![jsdelivr-badge][]][jsdelivr-link]
9
- [![npm-license-badge][]](LICENSE)
10
- [![codacy-badge][]][codacy-link]
11
- [![codeclimate-badge][]][codeclimate-link]
12
- [![snyk-badge][]][snyk-link]
13
- [![socket-badge][]][socket-link]
6
+ > Base functionality used throughout XY Labs TypeScript/JavaScript libraries
14
7
 
8
+ ## Install
15
9
 
16
- Base functionality used throughout XY Labs TypeScript/JavaScript libraries
10
+ Using npm:
17
11
 
12
+ ```sh
13
+ npm install {{name}}
14
+ ```
18
15
 
16
+ Using yarn:
19
17
 
20
- ## Reference
18
+ ```sh
19
+ yarn add {{name}}
20
+ ```
21
21
 
22
- **@xylabs/url**
22
+ Using pnpm:
23
+
24
+ ```sh
25
+ pnpm add {{name}}
26
+ ```
27
+
28
+ Using bun:
29
+
30
+ ```sh
31
+ bun add {{name}}
32
+ ```
23
33
 
24
- ***
25
34
 
26
- ## Modules
35
+ ## License
36
+
37
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
38
+
39
+ ## Reference
40
+
41
+ ### packages
27
42
 
28
- | Module | Description |
29
- | ------ | ------ |
30
- | [index-browser](#index-browser/README) | - |
31
- | [index-neutral](#index-neutral/README) | - |
32
- | [index-node](#index-node/README) | - |
43
+ ### url
33
44
 
34
- ### index-browser
45
+ ### .temp-typedoc
35
46
 
36
- ### functions
47
+ ### index-browser
37
48
 
38
- ### <a id="isLocalhost"></a>isLocalhost
49
+ ### functions
50
+
51
+ ### <a id="isLocalhost"></a>isLocalhost
39
52
 
40
53
  [**@xylabs/url**](#../../README)
41
54
 
42
55
  ***
43
56
 
44
57
  ```ts
45
- function isLocalhost(hostname: string): boolean;
58
+ function isLocalhost(hostname): boolean;
46
59
  ```
47
60
 
48
61
  Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1, or *.localhost).
49
62
 
50
63
  ## Parameters
51
64
 
52
- | Parameter | Type | Description |
53
- | ------ | ------ | ------ |
54
- | `hostname` | `string` | The hostname to check |
65
+ ### hostname
66
+
67
+ `string`
68
+
69
+ The hostname to check
55
70
 
56
71
  ## Returns
57
72
 
@@ -59,121 +74,96 @@ Checks whether a hostname refers to the local machine (localhost, 127.0.0.1, ::1
59
74
 
60
75
  `true` if the hostname is a localhost address
61
76
 
62
- ### variables
77
+ ### variables
63
78
 
64
- ### <a id="URL"></a>URL
79
+ ### <a id="URL"></a>URL
65
80
 
66
81
  [**@xylabs/url**](#../../README)
67
82
 
68
83
  ***
69
84
 
70
85
  ```ts
71
- const URL: (url: string | URL, base?: string | URL) => URL;
86
+ const URL: (url, base?) => URL;
72
87
  ```
73
88
 
74
89
  Browser-specific URL class, aliased from the global `URL`.
75
90
 
76
91
  ## Parameters
77
92
 
78
- | Parameter | Type |
79
- | ------ | ------ |
80
- | `url` | `string` \| `URL` |
81
- | `base?` | `string` \| `URL` |
93
+ ### url
94
+
95
+ `string` \| `URL`
96
+
97
+ ### base?
98
+
99
+ `string` \| `URL`
82
100
 
83
101
  ## Returns
84
102
 
85
103
  `URL`
86
104
 
87
- ### index-neutral
105
+ ### index-neutral
88
106
 
89
- ### variables
107
+ ### variables
90
108
 
91
- ### <a id="URL"></a>URL
109
+ ### <a id="URL"></a>URL
92
110
 
93
111
  [**@xylabs/url**](#../../README)
94
112
 
95
113
  ***
96
114
 
97
115
  ```ts
98
- const URL: (url: string | URL, base?: string | URL) => URL;
116
+ const URL: (url, base?) => URL;
99
117
  ```
100
118
 
101
119
  Platform-neutral URL class, aliased from the global `URL`.
102
120
 
103
121
  ## Parameters
104
122
 
105
- | Parameter | Type |
106
- | ------ | ------ |
107
- | `url` | `string` \| `URL` |
108
- | `base?` | `string` \| `URL` |
123
+ ### url
124
+
125
+ `string` \| `URL`
126
+
127
+ ### base?
128
+
129
+ `string` \| `URL`
109
130
 
110
131
  ## Returns
111
132
 
112
133
  `URL`
113
134
 
114
- ### index-node
135
+ ### index-node
115
136
 
116
- ### variables
137
+ ### variables
117
138
 
118
- ### <a id="URL"></a>URL
139
+ ### <a id="URL"></a>URL
119
140
 
120
141
  [**@xylabs/url**](#../../README)
121
142
 
122
143
  ***
123
144
 
124
145
  ```ts
125
- const URL: (url: string | URL, base?: string | URL) => URL;
146
+ const URL: (url, base?) => URL;
126
147
  ```
127
148
 
128
149
  Node.js-specific URL class, imported from the `node:url` module.
129
150
 
130
151
  ## Parameters
131
152
 
132
- | Parameter | Type |
133
- | ------ | ------ |
134
- | `url` | `string` \| `URL` |
135
- | `base?` | `string` \| `URL` |
136
-
137
- ## Returns
138
-
139
- `URL`
140
-
141
-
142
- Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
153
+ ### url
143
154
 
144
- ## Maintainers
155
+ `string` \| `URL`
145
156
 
146
- - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
147
- - [Matt Jones](https://github.com/jonesmac)
148
- - [Joel Carter](https://github.com/JoelBCarter)
149
- - [Jordan Trouw](https://github.com/jordantrouw)
157
+ ### base?
150
158
 
151
- ## License
159
+ `string` \| `URL`
152
160
 
153
- > See the [LICENSE](LICENSE) file for license details
154
-
155
- ## Credits
161
+ ## Returns
156
162
 
157
- [Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
163
+ `URL`
158
164
 
159
- [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
160
165
 
161
- [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
162
- [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
163
166
  [npm-badge]: https://img.shields.io/npm/v/@xylabs/url.svg
164
167
  [npm-link]: https://www.npmjs.com/package/@xylabs/url
165
- [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
166
- [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
167
- [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
168
- [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
169
- [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
170
- [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
171
-
172
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/url
173
- [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/url
174
-
175
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/url/badge
176
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/url
177
-
178
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/url
179
- [socket-link]: https://socket.dev/npm/package/@xylabs/url
168
+ [license-badge]: https://img.shields.io/npm/l/@xylabs/url.svg
169
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/url",
3
- "version": "5.0.95",
3
+ "version": "5.0.96",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "url",
@@ -51,14 +51,13 @@
51
51
  "README.md"
52
52
  ],
53
53
  "devDependencies": {
54
- "@types/node": "~25.5.2",
55
- "@xylabs/ts-scripts-common": "~7.8.4",
56
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
57
- "@xylabs/tsconfig": "~7.8.4",
54
+ "@types/node": "~25.6.0",
55
+ "@xylabs/toolchain": "~7.10.4",
56
+ "@xylabs/tsconfig": "~7.10.4",
58
57
  "esbuild": "^0.28.0",
59
58
  "typescript": "^5",
60
- "vite": "^8.0.5",
61
- "vitest": "^4.1.2"
59
+ "vite": "^8.0.8",
60
+ "vitest": "^4.1.4"
62
61
  },
63
62
  "engines": {
64
63
  "node": ">=18"