@isdk/web-searcher 0.1.5 → 0.1.6

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 (35) hide show
  1. package/README.cn.md +40 -0
  2. package/README.md +40 -0
  3. package/dist/index.d.mts +14 -0
  4. package/dist/index.d.ts +14 -0
  5. package/dist/index.js +1 -1
  6. package/dist/index.mjs +1 -1
  7. package/docs/README.md +40 -0
  8. package/docs/classes/GoogleSearcher.md +150 -48
  9. package/docs/classes/WebSearcher.md +138 -48
  10. package/docs/functions/extractDate.md +1 -1
  11. package/docs/functions/extractMetadataFrom.md +1 -1
  12. package/docs/functions/fetchHeaders.md +1 -1
  13. package/docs/functions/fetchPartial.md +1 -1
  14. package/docs/functions/normalizeDate.md +1 -1
  15. package/docs/functions/parseHeaders.md +1 -1
  16. package/docs/functions/parseHtml.md +1 -1
  17. package/docs/functions/testUrlsByLatency.md +5 -1
  18. package/docs/interfaces/CustomTimeRange.md +3 -3
  19. package/docs/interfaces/ExtractOptions.md +4 -4
  20. package/docs/interfaces/FetchExtractorOptions.md +3 -3
  21. package/docs/interfaces/FetcherOptions.md +41 -29
  22. package/docs/interfaces/HtmlData.md +4 -4
  23. package/docs/interfaces/MetadataResult.md +2 -2
  24. package/docs/interfaces/PaginationConfig.md +7 -7
  25. package/docs/interfaces/SearchContext.md +6 -6
  26. package/docs/interfaces/SearchOptions.md +13 -13
  27. package/docs/interfaces/StandardSearchResult.md +10 -10
  28. package/docs/interfaces/VerifiedUrl.md +3 -3
  29. package/docs/type-aliases/MetadataType.md +1 -1
  30. package/docs/type-aliases/SafeSearchLevel.md +1 -1
  31. package/docs/type-aliases/SearchCategory.md +1 -1
  32. package/docs/type-aliases/SearchTimeRange.md +1 -1
  33. package/docs/type-aliases/SearchTimeRangePreset.md +1 -1
  34. package/docs/type-aliases/SearcherConstructor.md +1 -1
  35. package/package.json +2 -2
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: FetcherOptions
8
8
 
9
- Defined in: web-fetcher/dist/index.d.ts:1108
9
+ Defined in: web-fetcher/dist/index.d.ts:1109
10
10
 
11
11
  ## Extends
12
12
 
@@ -18,7 +18,7 @@ Defined in: web-fetcher/dist/index.d.ts:1108
18
18
 
19
19
  > `optional` **actions**: `_RequireAtLeastOne`\<`FetchActionProperties`, `"name"` \| `"id"` \| `"action"`\>[]
20
20
 
21
- Defined in: web-fetcher/dist/index.d.ts:1109
21
+ Defined in: web-fetcher/dist/index.d.ts:1110
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: web-fetcher/dist/index.d.ts:1109
26
26
 
27
27
  > `optional` **antibot**: `boolean`
28
28
 
29
- Defined in: web-fetcher/dist/index.d.ts:1048
29
+ Defined in: web-fetcher/dist/index.d.ts:1049
30
30
 
31
31
  #### Inherited from
32
32
 
@@ -38,7 +38,7 @@ Defined in: web-fetcher/dist/index.d.ts:1048
38
38
 
39
39
  > `optional` **blockResources**: `string`[]
40
40
 
41
- Defined in: web-fetcher/dist/index.d.ts:1061
41
+ Defined in: web-fetcher/dist/index.d.ts:1062
42
42
 
43
43
  #### Inherited from
44
44
 
@@ -50,7 +50,7 @@ Defined in: web-fetcher/dist/index.d.ts:1061
50
50
 
51
51
  > `optional` **browser**: `object`
52
52
 
53
- Defined in: web-fetcher/dist/index.d.ts:1071
53
+ Defined in: web-fetcher/dist/index.d.ts:1072
54
54
 
55
55
  #### engine?
56
56
 
@@ -83,7 +83,7 @@ Defined in: web-fetcher/dist/index.d.ts:1071
83
83
 
84
84
  > `optional` **cache**: `FetchCacheOptions`
85
85
 
86
- Defined in: web-fetcher/dist/index.d.ts:1069
86
+ Defined in: web-fetcher/dist/index.d.ts:1070
87
87
 
88
88
  Cache configuration for persistent HTTP caching.
89
89
 
@@ -97,7 +97,7 @@ Cache configuration for persistent HTTP caching.
97
97
 
98
98
  > `optional` **cookies**: `Cookie`[]
99
99
 
100
- Defined in: web-fetcher/dist/index.d.ts:1051
100
+ Defined in: web-fetcher/dist/index.d.ts:1052
101
101
 
102
102
  #### Inherited from
103
103
 
@@ -109,7 +109,7 @@ Defined in: web-fetcher/dist/index.d.ts:1051
109
109
 
110
110
  > `optional` **debug**: `string` \| `boolean` \| `string`[]
111
111
 
112
- Defined in: web-fetcher/dist/index.d.ts:1049
112
+ Defined in: web-fetcher/dist/index.d.ts:1050
113
113
 
114
114
  #### Inherited from
115
115
 
@@ -121,7 +121,7 @@ Defined in: web-fetcher/dist/index.d.ts:1049
121
121
 
122
122
  > `optional` **delayBetweenRequestsMs**: `number`
123
123
 
124
- Defined in: web-fetcher/dist/index.d.ts:1091
124
+ Defined in: web-fetcher/dist/index.d.ts:1092
125
125
 
126
126
  #### Inherited from
127
127
 
@@ -163,7 +163,7 @@ Defined in: web-fetcher/dist/index.d.ts:1043
163
163
 
164
164
  > `optional` **headers**: `Record`\<`string`, `string`\>
165
165
 
166
- Defined in: web-fetcher/dist/index.d.ts:1050
166
+ Defined in: web-fetcher/dist/index.d.ts:1051
167
167
 
168
168
  #### Inherited from
169
169
 
@@ -175,7 +175,7 @@ Defined in: web-fetcher/dist/index.d.ts:1050
175
175
 
176
176
  > `optional` **http**: `object`
177
177
 
178
- Defined in: web-fetcher/dist/index.d.ts:1083
178
+ Defined in: web-fetcher/dist/index.d.ts:1084
179
179
 
180
180
  #### body?
181
181
 
@@ -195,7 +195,7 @@ Defined in: web-fetcher/dist/index.d.ts:1083
195
195
 
196
196
  > `optional` **ignoreSslErrors**: `boolean`
197
197
 
198
- Defined in: web-fetcher/dist/index.d.ts:1070
198
+ Defined in: web-fetcher/dist/index.d.ts:1071
199
199
 
200
200
  #### Inherited from
201
201
 
@@ -207,7 +207,7 @@ Defined in: web-fetcher/dist/index.d.ts:1070
207
207
 
208
208
  > `optional` **maxConcurrency**: `number`
209
209
 
210
- Defined in: web-fetcher/dist/index.d.ts:1089
210
+ Defined in: web-fetcher/dist/index.d.ts:1090
211
211
 
212
212
  #### Inherited from
213
213
 
@@ -219,7 +219,7 @@ Defined in: web-fetcher/dist/index.d.ts:1089
219
219
 
220
220
  > `optional` **maxRequestsPerMinute**: `number`
221
221
 
222
- Defined in: web-fetcher/dist/index.d.ts:1090
222
+ Defined in: web-fetcher/dist/index.d.ts:1091
223
223
 
224
224
  #### Inherited from
225
225
 
@@ -231,7 +231,7 @@ Defined in: web-fetcher/dist/index.d.ts:1090
231
231
 
232
232
  > `optional` **onPause**: `OnFetchPauseCallback`
233
233
 
234
- Defined in: web-fetcher/dist/index.d.ts:1110
234
+ Defined in: web-fetcher/dist/index.d.ts:1111
235
235
 
236
236
  ***
237
237
 
@@ -239,7 +239,7 @@ Defined in: web-fetcher/dist/index.d.ts:1110
239
239
 
240
240
  > `optional` **output**: `object`
241
241
 
242
- Defined in: web-fetcher/dist/index.d.ts:1056
242
+ Defined in: web-fetcher/dist/index.d.ts:1057
243
243
 
244
244
  #### cookies?
245
245
 
@@ -259,7 +259,7 @@ Defined in: web-fetcher/dist/index.d.ts:1056
259
259
 
260
260
  > `optional` **overrideSessionState**: `boolean`
261
261
 
262
- Defined in: web-fetcher/dist/index.d.ts:1054
262
+ Defined in: web-fetcher/dist/index.d.ts:1055
263
263
 
264
264
  #### Inherited from
265
265
 
@@ -271,7 +271,7 @@ Defined in: web-fetcher/dist/index.d.ts:1054
271
271
 
272
272
  > `optional` **proxy**: `string` \| `string`[]
273
273
 
274
- Defined in: web-fetcher/dist/index.d.ts:1060
274
+ Defined in: web-fetcher/dist/index.d.ts:1061
275
275
 
276
276
  #### Inherited from
277
277
 
@@ -283,7 +283,7 @@ Defined in: web-fetcher/dist/index.d.ts:1060
283
283
 
284
284
  > `optional` **requestHandlerTimeoutSecs**: `number`
285
285
 
286
- Defined in: web-fetcher/dist/index.d.ts:1088
286
+ Defined in: web-fetcher/dist/index.d.ts:1089
287
287
 
288
288
  #### Inherited from
289
289
 
@@ -295,7 +295,7 @@ Defined in: web-fetcher/dist/index.d.ts:1088
295
295
 
296
296
  > `optional` **retries**: `number`
297
297
 
298
- Defined in: web-fetcher/dist/index.d.ts:1092
298
+ Defined in: web-fetcher/dist/index.d.ts:1093
299
299
 
300
300
  #### Inherited from
301
301
 
@@ -307,7 +307,7 @@ Defined in: web-fetcher/dist/index.d.ts:1092
307
307
 
308
308
  > `optional` **sessionPoolOptions**: `SessionPoolOptions`
309
309
 
310
- Defined in: web-fetcher/dist/index.d.ts:1053
310
+ Defined in: web-fetcher/dist/index.d.ts:1054
311
311
 
312
312
  #### Inherited from
313
313
 
@@ -319,7 +319,7 @@ Defined in: web-fetcher/dist/index.d.ts:1053
319
319
 
320
320
  > `optional` **sessionState**: `any`
321
321
 
322
- Defined in: web-fetcher/dist/index.d.ts:1052
322
+ Defined in: web-fetcher/dist/index.d.ts:1053
323
323
 
324
324
  #### Inherited from
325
325
 
@@ -331,7 +331,7 @@ Defined in: web-fetcher/dist/index.d.ts:1052
331
331
 
332
332
  > `optional` **sites**: `FetchSite`[]
333
333
 
334
- Defined in: web-fetcher/dist/index.d.ts:1093
334
+ Defined in: web-fetcher/dist/index.d.ts:1094
335
335
 
336
336
  #### Inherited from
337
337
 
@@ -343,7 +343,7 @@ Defined in: web-fetcher/dist/index.d.ts:1093
343
343
 
344
344
  > `optional` **storage**: `StorageOptions`
345
345
 
346
- Defined in: web-fetcher/dist/index.d.ts:1065
346
+ Defined in: web-fetcher/dist/index.d.ts:1066
347
347
 
348
348
  Storage configuration for session isolation and persistence.
349
349
 
@@ -369,7 +369,7 @@ Defined in: web-fetcher/dist/index.d.ts:1045
369
369
 
370
370
  > `optional` **throwHttpErrors**: `boolean`
371
371
 
372
- Defined in: web-fetcher/dist/index.d.ts:1055
372
+ Defined in: web-fetcher/dist/index.d.ts:1056
373
373
 
374
374
  #### Inherited from
375
375
 
@@ -381,7 +381,7 @@ Defined in: web-fetcher/dist/index.d.ts:1055
381
381
 
382
382
  > `optional` **timeoutMs**: `number`
383
383
 
384
- Defined in: web-fetcher/dist/index.d.ts:1087
384
+ Defined in: web-fetcher/dist/index.d.ts:1088
385
385
 
386
386
  #### Inherited from
387
387
 
@@ -389,11 +389,23 @@ Defined in: web-fetcher/dist/index.d.ts:1087
389
389
 
390
390
  ***
391
391
 
392
+ ### upgradeOnJsContent?
393
+
394
+ > `optional` **upgradeOnJsContent**: `boolean`
395
+
396
+ Defined in: web-fetcher/dist/index.d.ts:1046
397
+
398
+ #### Inherited from
399
+
400
+ `BaseFetcherProperties.upgradeOnJsContent`
401
+
402
+ ***
403
+
392
404
  ### upgradeThresholdMs?
393
405
 
394
406
  > `optional` **upgradeThresholdMs**: `number`
395
407
 
396
- Defined in: web-fetcher/dist/index.d.ts:1046
408
+ Defined in: web-fetcher/dist/index.d.ts:1047
397
409
 
398
410
  #### Inherited from
399
411
 
@@ -405,7 +417,7 @@ Defined in: web-fetcher/dist/index.d.ts:1046
405
417
 
406
418
  > `optional` **url**: `string`
407
419
 
408
- Defined in: web-fetcher/dist/index.d.ts:1094
420
+ Defined in: web-fetcher/dist/index.d.ts:1095
409
421
 
410
422
  #### Inherited from
411
423
 
@@ -417,7 +429,7 @@ Defined in: web-fetcher/dist/index.d.ts:1094
417
429
 
418
430
  > `optional` **useSiteRegistry**: `boolean`
419
431
 
420
- Defined in: web-fetcher/dist/index.d.ts:1047
432
+ Defined in: web-fetcher/dist/index.d.ts:1048
421
433
 
422
434
  #### Inherited from
423
435
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: HtmlData
8
8
 
9
- Defined in: [web-searcher/src/utils/extractor/parser.ts:4](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/extractor/parser.ts#L4)
9
+ Defined in: [web-searcher/src/utils/extractor/parser.ts:4](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/extractor/parser.ts#L4)
10
10
 
11
11
  Represents structured data extracted from an HTML document.
12
12
 
@@ -16,7 +16,7 @@ Represents structured data extracted from an HTML document.
16
16
 
17
17
  > **jsonLd**: `any`[]
18
18
 
19
- Defined in: [web-searcher/src/utils/extractor/parser.ts:8](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/extractor/parser.ts#L8)
19
+ Defined in: [web-searcher/src/utils/extractor/parser.ts:8](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/extractor/parser.ts#L8)
20
20
 
21
21
  Array of parsed JSON-LD objects found in the document.
22
22
 
@@ -26,7 +26,7 @@ Array of parsed JSON-LD objects found in the document.
26
26
 
27
27
  > **meta**: `Record`\<`string`, `string`\>
28
28
 
29
- Defined in: [web-searcher/src/utils/extractor/parser.ts:6](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/extractor/parser.ts#L6)
29
+ Defined in: [web-searcher/src/utils/extractor/parser.ts:6](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/extractor/parser.ts#L6)
30
30
 
31
31
  Map of meta tag names/properties to their content. Keys are lowercase.
32
32
 
@@ -36,7 +36,7 @@ Map of meta tag names/properties to their content. Keys are lowercase.
36
36
 
37
37
  > **time**: `object`[]
38
38
 
39
- Defined in: [web-searcher/src/utils/extractor/parser.ts:10](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/extractor/parser.ts#L10)
39
+ Defined in: [web-searcher/src/utils/extractor/parser.ts:10](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/extractor/parser.ts#L10)
40
40
 
41
41
  Array of data from HTML <time> tags.
42
42
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: MetadataResult
8
8
 
9
- Defined in: [web-searcher/src/utils/extractor/extractor.ts:7](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/extractor/extractor.ts#L7)
9
+ Defined in: [web-searcher/src/utils/extractor/extractor.ts:7](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/extractor/extractor.ts#L7)
10
10
 
11
11
  Result object for generic metadata extraction.
12
12
 
@@ -22,6 +22,6 @@ Placeholders for future metadata fields.
22
22
 
23
23
  > `optional` **date**: `string` \| `null`
24
24
 
25
- Defined in: [web-searcher/src/utils/extractor/extractor.ts:9](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/extractor/extractor.ts#L9)
25
+ Defined in: [web-searcher/src/utils/extractor/extractor.ts:9](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/extractor/extractor.ts#L9)
26
26
 
27
27
  The extracted and normalized date, if any.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: PaginationConfig
8
8
 
9
- Defined in: [web-searcher/src/types.ts:41](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L41)
9
+ Defined in: [web-searcher/src/types.ts:41](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L41)
10
10
 
11
11
  Configuration for pagination strategies.
12
12
  Defines how the searcher should navigate to the next page of results.
@@ -17,7 +17,7 @@ Defines how the searcher should navigate to the next page of results.
17
17
 
18
18
  > `optional` **increment**: `number`
19
19
 
20
- Defined in: [web-searcher/src/types.ts:68](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L68)
20
+ Defined in: [web-searcher/src/types.ts:68](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L68)
21
21
 
22
22
  The increment step for each page.
23
23
  - If the parameter represents an item offset (like Google's 'start'), this might be 10.
@@ -35,7 +35,7 @@ The increment step for each page.
35
35
 
36
36
  > `optional` **maxPages**: `number`
37
37
 
38
- Defined in: [web-searcher/src/types.ts:85](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L85)
38
+ Defined in: [web-searcher/src/types.ts:85](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L85)
39
39
 
40
40
  The safety threshold for the maximum number of pages to fetch automatically
41
41
  in a single search call.
@@ -55,7 +55,7 @@ will stop after this many pages to prevent infinite loops or excessive API usage
55
55
 
56
56
  > `optional` **nextButtonSelector**: `string`
57
57
 
58
- Defined in: [web-searcher/src/types.ts:74](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L74)
58
+ Defined in: [web-searcher/src/types.ts:74](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L74)
59
59
 
60
60
  The CSS selector for the "Next" page button.
61
61
  Required if type is 'click-next'.
@@ -66,7 +66,7 @@ Required if type is 'click-next'.
66
66
 
67
67
  > `optional` **paramName**: `string`
68
68
 
69
- Defined in: [web-searcher/src/types.ts:54](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L54)
69
+ Defined in: [web-searcher/src/types.ts:54](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L54)
70
70
 
71
71
  The name of the URL parameter used for pagination.
72
72
  Required if type is 'url-param'.
@@ -83,7 +83,7 @@ Required if type is 'url-param'.
83
83
 
84
84
  > `optional` **startValue**: `number`
85
85
 
86
- Defined in: [web-searcher/src/types.ts:60](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L60)
86
+ Defined in: [web-searcher/src/types.ts:60](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L60)
87
87
 
88
88
  The starting value for the pagination parameter.
89
89
 
@@ -99,7 +99,7 @@ The starting value for the pagination parameter.
99
99
 
100
100
  > **type**: `"url-param"` \| `"click-next"`
101
101
 
102
- Defined in: [web-searcher/src/types.ts:47](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L47)
102
+ Defined in: [web-searcher/src/types.ts:47](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L47)
103
103
 
104
104
  The type of pagination mechanism:
105
105
  - 'url-param': Pagination is handled by modifying URL parameters (e.g., `?page=2` or `?start=10`).
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SearchContext
8
8
 
9
- Defined in: [web-searcher/src/types.ts:91](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L91)
9
+ Defined in: [web-searcher/src/types.ts:91](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L91)
10
10
 
11
11
  Context object passed to the transform function.
12
12
 
@@ -22,7 +22,7 @@ Allows for custom variables passed via search options.
22
22
 
23
23
  > `optional` **baseUrl**: `string`
24
24
 
25
- Defined in: [web-searcher/src/types.ts:105](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L105)
25
+ Defined in: [web-searcher/src/types.ts:105](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L105)
26
26
 
27
27
  The baseUrl used for this specific fetch (if multi-instance is enabled)
28
28
 
@@ -32,7 +32,7 @@ The baseUrl used for this specific fetch (if multi-instance is enabled)
32
32
 
33
33
  > `optional` **engine**: `string`
34
34
 
35
- Defined in: [web-searcher/src/types.ts:108](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L108)
35
+ Defined in: [web-searcher/src/types.ts:108](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L108)
36
36
 
37
37
  The name of the engine executing the search
38
38
 
@@ -42,7 +42,7 @@ The name of the engine executing the search
42
42
 
43
43
  > `optional` **limit**: `number`
44
44
 
45
- Defined in: [web-searcher/src/types.ts:99](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L99)
45
+ Defined in: [web-searcher/src/types.ts:99](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L99)
46
46
 
47
47
  The requested limit of results.
48
48
 
@@ -52,7 +52,7 @@ The requested limit of results.
52
52
 
53
53
  > **page**: `number`
54
54
 
55
- Defined in: [web-searcher/src/types.ts:96](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L96)
55
+ Defined in: [web-searcher/src/types.ts:96](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L96)
56
56
 
57
57
  The current page index (0-based).
58
58
 
@@ -62,6 +62,6 @@ The current page index (0-based).
62
62
 
63
63
  > **query**: `string`
64
64
 
65
- Defined in: [web-searcher/src/types.ts:93](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L93)
65
+ Defined in: [web-searcher/src/types.ts:93](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L93)
66
66
 
67
67
  The original search query.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SearchOptions
8
8
 
9
- Defined in: [web-searcher/src/types.ts:129](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L129)
9
+ Defined in: [web-searcher/src/types.ts:129](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L129)
10
10
 
11
11
  Options provided when executing a search.
12
12
 
@@ -22,7 +22,7 @@ Any other custom variables to be injected into the template.
22
22
 
23
23
  > `optional` **baseUrls**: `string`[] \| `Record`\<`string`, `string`[]\>
24
24
 
25
- Defined in: [web-searcher/src/types.ts:187](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L187)
25
+ Defined in: [web-searcher/src/types.ts:187](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L187)
26
26
 
27
27
  Allows the user to dynamically specify or override the base URLs for the engines.
28
28
  Can be an array of URLs for a single engine, or a map of engine names to URL arrays.
@@ -33,7 +33,7 @@ Can be an array of URLs for a single engine, or a map of engine names to URL arr
33
33
 
34
34
  > `optional` **category**: `string`
35
35
 
36
- Defined in: [web-searcher/src/types.ts:153](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L153)
36
+ Defined in: [web-searcher/src/types.ts:153](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L153)
37
37
 
38
38
  The category of results to return.
39
39
  Default: 'all' (web search)
@@ -44,7 +44,7 @@ Default: 'all' (web search)
44
44
 
45
45
  > `optional` **fillLimit**: `boolean`
46
46
 
47
- Defined in: [web-searcher/src/types.ts:204](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L204)
47
+ Defined in: [web-searcher/src/types.ts:204](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L204)
48
48
 
49
49
  If true (default), the searcher will attempt to fulfill the requested `limit`
50
50
  by falling back to subsequent engines in the chain if previous ones are exhausted.
@@ -57,7 +57,7 @@ the limit was reached.
57
57
 
58
58
  > `optional` **language**: `string`
59
59
 
60
- Defined in: [web-searcher/src/types.ts:163](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L163)
60
+ Defined in: [web-searcher/src/types.ts:163](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L163)
61
61
 
62
62
  Language code (ISO 639-1) for the interface or results (e.g., 'en', 'zh-CN').
63
63
 
@@ -67,7 +67,7 @@ Language code (ISO 639-1) for the interface or results (e.g., 'en', 'zh-CN').
67
67
 
68
68
  > `optional` **limit**: `number`
69
69
 
70
- Defined in: [web-searcher/src/types.ts:131](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L131)
70
+ Defined in: [web-searcher/src/types.ts:131](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L131)
71
71
 
72
72
  The maximum number of results to retrieve.
73
73
 
@@ -77,7 +77,7 @@ The maximum number of results to retrieve.
77
77
 
78
78
  > `optional` **maxPages**: `number`
79
79
 
80
- Defined in: [web-searcher/src/types.ts:141](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L141)
80
+ Defined in: [web-searcher/src/types.ts:141](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L141)
81
81
 
82
82
  The maximum number of pages (fetch cycles) allowed to reach the requested `limit`.
83
83
 
@@ -92,7 +92,7 @@ If not provided, it defaults to the value in `PaginationConfig` or 10.
92
92
 
93
93
  > `optional` **region**: `string`
94
94
 
95
- Defined in: [web-searcher/src/types.ts:158](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L158)
95
+ Defined in: [web-searcher/src/types.ts:158](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L158)
96
96
 
97
97
  Region code (ISO 3166-1 alpha-2) to bias results (e.g., 'US', 'CN', 'JP').
98
98
 
@@ -102,7 +102,7 @@ Region code (ISO 3166-1 alpha-2) to bias results (e.g., 'US', 'CN', 'JP').
102
102
 
103
103
  > `optional` **safeSearch**: [`SafeSearchLevel`](../type-aliases/SafeSearchLevel.md)
104
104
 
105
- Defined in: [web-searcher/src/types.ts:169](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L169)
105
+ Defined in: [web-searcher/src/types.ts:169](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L169)
106
106
 
107
107
  Safe search filtering level.
108
108
  Default: engine dependent (usually 'moderate' or 'strict' by default).
@@ -113,7 +113,7 @@ Default: engine dependent (usually 'moderate' or 'strict' by default).
113
113
 
114
114
  > `optional` **startPage**: `number`
115
115
 
116
- Defined in: [web-searcher/src/types.ts:211](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L211)
116
+ Defined in: [web-searcher/src/types.ts:211](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L211)
117
117
 
118
118
  Specifies which page index to start the search from.
119
119
  Useful when delegating pagination across different sessions.
@@ -130,7 +130,7 @@ Useful when delegating pagination across different sessions.
130
130
 
131
131
  > `optional` **timeRange**: [`SearchTimeRange`](../type-aliases/SearchTimeRange.md)
132
132
 
133
- Defined in: [web-searcher/src/types.ts:147](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L147)
133
+ Defined in: [web-searcher/src/types.ts:147](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L147)
134
134
 
135
135
  Date range for the search results.
136
136
  Default: 'all'
@@ -141,7 +141,7 @@ Default: 'all'
141
141
 
142
142
  > `optional` **transform**: (`results`, `context`) => [`StandardSearchResult`](StandardSearchResult.md)[] \| `Promise`\<[`StandardSearchResult`](StandardSearchResult.md)[]\>
143
143
 
144
- Defined in: [web-searcher/src/types.ts:175](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L175)
144
+ Defined in: [web-searcher/src/types.ts:175](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L175)
145
145
 
146
146
  A custom transform function to filter or modify results at runtime.
147
147
  This runs AFTER the engine-level transform.
@@ -166,7 +166,7 @@ This runs AFTER the engine-level transform.
166
166
 
167
167
  > `optional` **validator**: (`results`, `context`) => `boolean` \| `Promise`\<`boolean`\>
168
168
 
169
- Defined in: [web-searcher/src/types.ts:193](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L193)
169
+ Defined in: [web-searcher/src/types.ts:193](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L193)
170
170
 
171
171
  User-defined callback to validate the fetched results for a page.
172
172
  If it returns false, the fetch is considered a failure, triggering the retry/failover mechanism.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: StandardSearchResult
8
8
 
9
- Defined in: [web-searcher/src/types.ts:5](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L5)
9
+ Defined in: [web-searcher/src/types.ts:5](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L5)
10
10
 
11
11
  Interface representing a standardized search result item.
12
12
  This ensures consistency across different search engines.
@@ -23,7 +23,7 @@ Allows for engine-specific extra fields (e.g., siteIcon, category).
23
23
 
24
24
  > `optional` **author**: `string`
25
25
 
26
- Defined in: [web-searcher/src/types.ts:22](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L22)
26
+ Defined in: [web-searcher/src/types.ts:22](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L22)
27
27
 
28
28
  The author or source name of the result.
29
29
 
@@ -33,7 +33,7 @@ The author or source name of the result.
33
33
 
34
34
  > `optional` **date**: `string` \| `Date`
35
35
 
36
- Defined in: [web-searcher/src/types.ts:19](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L19)
36
+ Defined in: [web-searcher/src/types.ts:19](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L19)
37
37
 
38
38
  The date the result was published or last updated.
39
39
 
@@ -43,7 +43,7 @@ The date the result was published or last updated.
43
43
 
44
44
  > `optional` **favicon**: `string`
45
45
 
46
- Defined in: [web-searcher/src/types.ts:25](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L25)
46
+ Defined in: [web-searcher/src/types.ts:25](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L25)
47
47
 
48
48
  The favicon URL of the source website.
49
49
 
@@ -53,7 +53,7 @@ The favicon URL of the source website.
53
53
 
54
54
  > `optional` **image**: `string`
55
55
 
56
- Defined in: [web-searcher/src/types.ts:16](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L16)
56
+ Defined in: [web-searcher/src/types.ts:16](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L16)
57
57
 
58
58
  An optional image URL associated with the result.
59
59
 
@@ -63,7 +63,7 @@ An optional image URL associated with the result.
63
63
 
64
64
  > `optional` **rank**: `number`
65
65
 
66
- Defined in: [web-searcher/src/types.ts:28](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L28)
66
+ Defined in: [web-searcher/src/types.ts:28](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L28)
67
67
 
68
68
  The rank or position of the result (usually 1-indexed).
69
69
 
@@ -73,7 +73,7 @@ The rank or position of the result (usually 1-indexed).
73
73
 
74
74
  > `optional` **snippet**: `string`
75
75
 
76
- Defined in: [web-searcher/src/types.ts:13](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L13)
76
+ Defined in: [web-searcher/src/types.ts:13](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L13)
77
77
 
78
78
  A brief snippet or description of the result.
79
79
 
@@ -83,7 +83,7 @@ A brief snippet or description of the result.
83
83
 
84
84
  > `optional` **source**: `string`
85
85
 
86
- Defined in: [web-searcher/src/types.ts:31](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L31)
86
+ Defined in: [web-searcher/src/types.ts:31](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L31)
87
87
 
88
88
  The source website name (e.g., 'GitHub', 'StackOverflow').
89
89
 
@@ -93,7 +93,7 @@ The source website name (e.g., 'GitHub', 'StackOverflow').
93
93
 
94
94
  > **title**: `string`
95
95
 
96
- Defined in: [web-searcher/src/types.ts:7](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L7)
96
+ Defined in: [web-searcher/src/types.ts:7](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L7)
97
97
 
98
98
  The title of the search result.
99
99
 
@@ -103,6 +103,6 @@ The title of the search result.
103
103
 
104
104
  > **url**: `string`
105
105
 
106
- Defined in: [web-searcher/src/types.ts:10](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/types.ts#L10)
106
+ Defined in: [web-searcher/src/types.ts:10](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/types.ts#L10)
107
107
 
108
108
  The URL of the search result.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: VerifiedUrl
8
8
 
9
- Defined in: [web-searcher/src/utils/latency.ts:3](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/latency.ts#L3)
9
+ Defined in: [web-searcher/src/utils/latency.ts:3](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/latency.ts#L3)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [web-searcher/src/utils/latency.ts:3](https://github.com/isdk/web-se
14
14
 
15
15
  > **latency**: `number`
16
16
 
17
- Defined in: [web-searcher/src/utils/latency.ts:5](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/latency.ts#L5)
17
+ Defined in: [web-searcher/src/utils/latency.ts:5](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/latency.ts#L5)
18
18
 
19
19
  ***
20
20
 
@@ -22,4 +22,4 @@ Defined in: [web-searcher/src/utils/latency.ts:5](https://github.com/isdk/web-se
22
22
 
23
23
  > **url**: `string`
24
24
 
25
- Defined in: [web-searcher/src/utils/latency.ts:4](https://github.com/isdk/web-searcher.js/blob/955bc509edda39926bd12c6c2b8c28da7eb13ff5/src/utils/latency.ts#L4)
25
+ Defined in: [web-searcher/src/utils/latency.ts:4](https://github.com/isdk/web-searcher.js/blob/0c4757eb75b3b7c5af0231806f11e7b3c3166736/src/utils/latency.ts#L4)