-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathurl.ts
More file actions
278 lines (260 loc) · 6.77 KB
/
url.ts
File metadata and controls
278 lines (260 loc) · 6.77 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/**
* @fileoverview URL parsing and validation utilities.
* Provides URL validation, normalization, and parsing helpers.
*/
import {
NumberIsNaN,
StringPrototypeEndsWith,
StringPrototypeReplace,
} from './primordials'
const BooleanCtor = Boolean
const UrlCtor = URL
export interface CreateRelativeUrlOptions {
base?: string
}
export interface UrlSearchParamAsBooleanOptions {
defaultValue?: boolean
}
export interface UrlSearchParamAsNumberOptions {
defaultValue?: number
}
export interface UrlSearchParamAsStringOptions {
defaultValue?: string
}
export interface UrlSearchParamsGetBooleanOptions {
defaultValue?: boolean
}
/**
* Create a relative URL for testing.
*
* @example
* ```typescript
* createRelativeUrl('/api/test') // 'api/test'
* createRelativeUrl('/api/test', { base: 'https://example.com' }) // 'https://example.com/api/test'
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function createRelativeUrl(
path: string,
options?: CreateRelativeUrlOptions | undefined,
): string {
const { base = '' } = {
__proto__: null,
...options,
} as CreateRelativeUrlOptions
// Remove leading slash to make it relative.
const relativePath = StringPrototypeReplace(path, /^\//, '')
if (base) {
let baseUrl = base
if (!StringPrototypeEndsWith(baseUrl, '/')) {
baseUrl += '/'
}
return baseUrl + relativePath
}
return relativePath
}
/**
* Check if a value is a valid URL.
*
* @example
* ```typescript
* isUrl('https://example.com') // true
* isUrl('not a url') // false
* isUrl(null) // false
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function isUrl(value: string | URL | null | undefined): boolean {
return (
((typeof value === 'string' && value !== '') ||
(value !== null && typeof value === 'object')) &&
!!parseUrl(value)
)
}
/**
* Parse a value as a URL.
*
* @example
* ```typescript
* parseUrl('https://example.com') // URL { href: 'https://example.com/' }
* parseUrl('invalid') // undefined
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function parseUrl(value: string | URL): URL | undefined {
try {
return new UrlCtor(value)
} catch {}
return undefined
}
/**
* Convert a URL search parameter to an array.
*
* @example
* ```typescript
* urlSearchParamAsArray('a, b, c') // ['a', 'b', 'c']
* urlSearchParamAsArray(null) // []
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function urlSearchParamAsArray(
value: string | null | undefined,
): string[] {
return typeof value === 'string'
? value
.trim()
.split(/, */)
.map(v => v.trim())
.filter(BooleanCtor)
: []
}
/**
* Convert a URL search parameter to a boolean.
*
* @example
* ```typescript
* urlSearchParamAsBoolean('true') // true
* urlSearchParamAsBoolean('0') // false
* urlSearchParamAsBoolean(null) // false
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function urlSearchParamAsBoolean(
value: string | null | undefined,
options?: UrlSearchParamAsBooleanOptions | undefined,
): boolean {
const { defaultValue = false } = {
__proto__: null,
...options,
} as UrlSearchParamAsBooleanOptions
if (typeof value === 'string') {
const trimmed = value.trim()
// Empty string → use defaultValue, same as null/undefined. Previously
// fell through to the final truthy check and returned false, silently
// bypassing `defaultValue: true`.
if (trimmed === '') {
return !!defaultValue
}
const lowered = trimmed.toLowerCase()
// Accept the same truthy vocabulary as `envAsBoolean` so query-string
// flags behave predictably cross-context: '1', 'true', 'yes', 'on'.
return (
lowered === '1' ||
lowered === 'true' ||
lowered === 'yes' ||
lowered === 'on'
)
}
if (value === null || value === undefined) {
return !!defaultValue
}
return !!value
}
/**
* Get number value from URLSearchParams with a default.
*
* @example
* ```typescript
* const params = new URLSearchParams('limit=10')
* urlSearchParamAsNumber(params, 'limit') // 10
* urlSearchParamAsNumber(params, 'other') // 0
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function urlSearchParamAsNumber(
params: URLSearchParams | null | undefined,
key: string,
options?: UrlSearchParamAsNumberOptions | undefined,
): number {
const { defaultValue = 0 } = {
__proto__: null,
...options,
} as UrlSearchParamAsNumberOptions
if (params && typeof params.get === 'function') {
const value = params.get(key)
if (value !== null) {
const num = Number(value)
return !NumberIsNaN(num) ? num : defaultValue
}
}
return defaultValue
}
/**
* Get string value from URLSearchParams with a default.
*
* @example
* ```typescript
* const params = new URLSearchParams('name=socket')
* urlSearchParamAsString(params, 'name') // 'socket'
* urlSearchParamAsString(params, 'other') // ''
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function urlSearchParamAsString(
params: URLSearchParams | null | undefined,
key: string,
options?: UrlSearchParamAsStringOptions | undefined,
): string {
const { defaultValue = '' } = {
__proto__: null,
...options,
} as UrlSearchParamAsStringOptions
if (params && typeof params.get === 'function') {
const value = params.get(key)
return value !== null ? value : defaultValue
}
return defaultValue
}
/**
* Helper to get array from URLSearchParams.
*
* @example
* ```typescript
* const params = new URLSearchParams('tags=a,b,c')
* urlSearchParamsGetArray(params, 'tags') // ['a', 'b', 'c']
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function urlSearchParamsGetArray(
params: URLSearchParams | null | undefined,
key: string,
): string[] {
if (params && typeof params.getAll === 'function') {
const values = params.getAll(key)
// If single value contains commas, split it
const firstValue = values[0]
if (values.length === 1 && firstValue && firstValue.includes(',')) {
return urlSearchParamAsArray(firstValue)
}
return values
}
return []
}
/**
* Helper to get boolean from URLSearchParams.
*
* @example
* ```typescript
* const params = new URLSearchParams('debug=true')
* urlSearchParamsGetBoolean(params, 'debug') // true
* urlSearchParamsGetBoolean(params, 'other') // false
* ```
*/
/*@__NO_SIDE_EFFECTS__*/
export function urlSearchParamsGetBoolean(
params: URLSearchParams | null | undefined,
key: string,
options?: UrlSearchParamsGetBooleanOptions | undefined,
): boolean {
const { defaultValue = false } = {
__proto__: null,
...options,
} as UrlSearchParamsGetBooleanOptions
if (params && typeof params.get === 'function') {
const value = params.get(key)
return value !== null
? urlSearchParamAsBoolean(value, { defaultValue })
: defaultValue
}
return defaultValue
}