@isdk/web-searcher 0.1.2 → 0.1.4

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.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: GoogleSearcher
8
8
 
9
- Defined in: [web-searcher/src/engines/google.ts:24](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/engines/google.ts#L24)
9
+ Defined in: [web-searcher/src/engines/google.ts:24](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L24)
10
10
 
11
11
  A sample implementation of a Google Search scraper.
12
12
 
@@ -37,7 +37,7 @@ Use this class to understand:
37
37
 
38
38
  > **new GoogleSearcher**(`options?`): `GoogleSearcher`
39
39
 
40
- Defined in: web-fetcher/dist/index.d.ts:2192
40
+ Defined in: web-fetcher/dist/index.d.ts:2287
41
41
 
42
42
  Creates a new FetchSession.
43
43
 
@@ -63,7 +63,7 @@ Configuration options for the fetcher.
63
63
 
64
64
  > `protected` **closed**: `boolean`
65
65
 
66
- Defined in: web-fetcher/dist/index.d.ts:2186
66
+ Defined in: web-fetcher/dist/index.d.ts:2281
67
67
 
68
68
  #### Inherited from
69
69
 
@@ -75,7 +75,7 @@ Defined in: web-fetcher/dist/index.d.ts:2186
75
75
 
76
76
  > `readonly` **context**: `FetchContext`
77
77
 
78
- Defined in: web-fetcher/dist/index.d.ts:2185
78
+ Defined in: web-fetcher/dist/index.d.ts:2280
79
79
 
80
80
  The execution context for this session, containing configurations, event bus, and shared state.
81
81
 
@@ -89,7 +89,7 @@ The execution context for this session, containing configurations, event bus, an
89
89
 
90
90
  > `readonly` **id**: `string`
91
91
 
92
- Defined in: web-fetcher/dist/index.d.ts:2181
92
+ Defined in: web-fetcher/dist/index.d.ts:2276
93
93
 
94
94
  Unique identifier for the session.
95
95
 
@@ -103,7 +103,7 @@ Unique identifier for the session.
103
103
 
104
104
  > `protected` **options**: `FetcherOptions`
105
105
 
106
- Defined in: web-fetcher/dist/index.d.ts:2177
106
+ Defined in: web-fetcher/dist/index.d.ts:2272
107
107
 
108
108
  #### Inherited from
109
109
 
@@ -115,7 +115,7 @@ Defined in: web-fetcher/dist/index.d.ts:2177
115
115
 
116
116
  > `static` **\_isFactory**: `boolean` = `false`
117
117
 
118
- Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L33)
118
+ Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L33)
119
119
 
120
120
  #### Inherited from
121
121
 
@@ -127,7 +127,7 @@ Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-search
127
127
 
128
128
  > `static` **alias**: `string`[]
129
129
 
130
- Defined in: [web-searcher/src/engines/google.ts:25](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/engines/google.ts#L25)
130
+ Defined in: [web-searcher/src/engines/google.ts:25](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L25)
131
131
 
132
132
  Engine alias(es). Can be a single string or an array of strings.
133
133
  Useful for registering shorthand names (e.g., 'g' for 'Google').
@@ -142,7 +142,7 @@ Useful for registering shorthand names (e.g., 'g' for 'Google').
142
142
 
143
143
  > `static` **createObject**: (`name`, ...`args`) => [`WebSearcher`](WebSearcher.md)
144
144
 
145
- Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L78)
145
+ Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L78)
146
146
 
147
147
  Creates an instance of the registered search engine.
148
148
 
@@ -176,7 +176,7 @@ An instance of the search engine.
176
176
 
177
177
  > `static` **forEach**: (`cb`) => `void`
178
178
 
179
- Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L85)
179
+ Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L85)
180
180
 
181
181
  Iterates over all registered engines.
182
182
 
@@ -202,7 +202,7 @@ Callback function to invoke for each registered engine.
202
202
 
203
203
  > `static` **get**: (`name`) => *typeof* [`WebSearcher`](WebSearcher.md)
204
204
 
205
- Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L69)
205
+ Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L69)
206
206
 
207
207
  Retrieves a registered search engine class by name.
208
208
 
@@ -230,7 +230,7 @@ The search engine class constructor.
230
230
 
231
231
  > `static` `optional` **name**: `string`
232
232
 
233
- Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L40)
233
+ Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L40)
234
234
 
235
235
  Custom engine name. If not provided, it is derived from the class name.
236
236
  For example, `GoogleSearcher` becomes `Google`.
@@ -245,7 +245,7 @@ For example, `GoogleSearcher` becomes `Google`.
245
245
 
246
246
  > `static` **register**: (`ctor`, `options?`) => `boolean`
247
247
 
248
- Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L54)
248
+ Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L54)
249
249
 
250
250
  Registers a search engine class.
251
251
 
@@ -279,7 +279,7 @@ Registration options. If a string is provided, it is used as the registered name
279
279
 
280
280
  > `static` **setAliases**: (`ctor`, ...`aliases`) => `void`
281
281
 
282
- Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L93)
282
+ Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L93)
283
283
 
284
284
  Sets aliases for a registered engine.
285
285
 
@@ -311,7 +311,7 @@ Aliases to add.
311
311
 
312
312
  > `static` **unregister**: (`name?`) => `void`
313
313
 
314
- Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L61)
314
+ Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L61)
315
315
 
316
316
  Unregisters a search engine.
317
317
 
@@ -339,7 +339,7 @@ The name or class to unregister.
339
339
 
340
340
  > **get** **pagination**(): [`PaginationConfig`](../interfaces/PaginationConfig.md)
341
341
 
342
- Defined in: [web-searcher/src/engines/google.ts:61](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/engines/google.ts#L61)
342
+ Defined in: [web-searcher/src/engines/google.ts:61](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L61)
343
343
 
344
344
  Configures pagination for Google Search results.
345
345
  Uses the 'start' URL parameter, incrementing by 10 for each page.
@@ -360,7 +360,7 @@ Uses the 'start' URL parameter, incrementing by 10 for each page.
360
360
 
361
361
  > **get** **template**(): `FetcherOptions`
362
362
 
363
- Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/engines/google.ts#L32)
363
+ Defined in: [web-searcher/src/engines/google.ts:32](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L32)
364
364
 
365
365
  Defines the fetch template for Google Search.
366
366
 
@@ -380,7 +380,7 @@ The fetcher configuration including the URL pattern and extraction rules.
380
380
 
381
381
  > `protected` **createContext**(`options`): `FetchContext`
382
382
 
383
- Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L155)
383
+ Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L155)
384
384
 
385
385
  #### Parameters
386
386
 
@@ -402,7 +402,7 @@ Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searc
402
402
 
403
403
  > **dispose**(): `Promise`\<`void`\>
404
404
 
405
- Defined in: web-fetcher/dist/index.d.ts:2251
405
+ Defined in: web-fetcher/dist/index.d.ts:2346
406
406
 
407
407
  Disposes of the session and its associated engine.
408
408
 
@@ -425,7 +425,7 @@ This method should be called when the session is no longer needed to free up res
425
425
 
426
426
  > **execute**\<`R`\>(`actionOptions`, `context?`): `Promise`\<`FetchActionResult`\<`R`\>\>
427
427
 
428
- Defined in: web-fetcher/dist/index.d.ts:2206
428
+ Defined in: web-fetcher/dist/index.d.ts:2301
429
429
 
430
430
  Executes a single action within the session.
431
431
 
@@ -473,7 +473,7 @@ await session.execute({ name: 'goto', params: { url: 'https://example.com' } });
473
473
 
474
474
  > **executeAll**(`actions`, `options?`): `Promise`\<\{ `outputs`: `Record`\<`string`, `any`\>; `result`: `FetchResponse` \| `undefined`; \}\>
475
475
 
476
- Defined in: web-fetcher/dist/index.d.ts:2223
476
+ Defined in: web-fetcher/dist/index.d.ts:2318
477
477
 
478
478
  Executes a sequence of actions.
479
479
 
@@ -517,7 +517,7 @@ const { result, outputs } = await session.executeAll([
517
517
 
518
518
  > `protected` **formatOptions**(`options`): `Record`\<`string`, `any`\>
519
519
 
520
- Defined in: [web-searcher/src/engines/google.ts:82](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/engines/google.ts#L82)
520
+ Defined in: [web-searcher/src/engines/google.ts:82](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L82)
521
521
 
522
522
  Maps standard `SearchOptions` to Google's specific URL parameters.
523
523
 
@@ -551,7 +551,7 @@ A map of variables to inject into the URL template.
551
551
 
552
552
  > **getOutputs**(): `Record`\<`string`, `any`\>
553
553
 
554
- Defined in: web-fetcher/dist/index.d.ts:2234
554
+ Defined in: web-fetcher/dist/index.d.ts:2329
555
555
 
556
556
  Retrieves all outputs accumulated during the session.
557
557
 
@@ -571,7 +571,7 @@ A record of stored output data.
571
571
 
572
572
  > **getState**(): `Promise`\<\{ `cookies`: `Cookie`[]; `sessionState?`: `any`; \} \| `undefined`\>
573
573
 
574
- Defined in: web-fetcher/dist/index.d.ts:2240
574
+ Defined in: web-fetcher/dist/index.d.ts:2335
575
575
 
576
576
  Gets the current state of the session, including cookies and engine-specific state.
577
577
 
@@ -591,7 +591,7 @@ A promise resolving to the session state, or undefined if no engine is initializ
591
591
 
592
592
  > **search**(`query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
593
593
 
594
- Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L182)
594
+ Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L182)
595
595
 
596
596
  Executes a search query.
597
597
 
@@ -628,7 +628,7 @@ A promise resolving to an array of standardized search results.
628
628
 
629
629
  > `protected` **transform**(`outputs`): `Promise`\<`any`[]\>
630
630
 
631
- Defined in: [web-searcher/src/engines/google.ts:144](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/engines/google.ts#L144)
631
+ Defined in: [web-searcher/src/engines/google.ts:145](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/engines/google.ts#L145)
632
632
 
633
633
  Cleans and normalizes the extracted results.
634
634
  Specifically, it unwraps Google's redirect URLs (starting with `/url?q=`).
@@ -657,7 +657,7 @@ An array of cleaned search results.
657
657
 
658
658
  > `static` **search**(`engineName`, `query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
659
659
 
660
- Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L106)
660
+ Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L106)
661
661
 
662
662
  Static helper to execute a one-off search.
663
663
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Abstract Class: WebSearcher
8
8
 
9
- Defined in: [web-searcher/src/searcher.ts:31](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L31)
9
+ Defined in: [web-searcher/src/searcher.ts:31](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L31)
10
10
 
11
11
  The abstract base class for all search engines.
12
12
 
@@ -41,7 +41,7 @@ WebSearcher.register(MySearcher);
41
41
 
42
42
  > **new WebSearcher**(`options?`): `WebSearcher`
43
43
 
44
- Defined in: web-fetcher/dist/index.d.ts:2192
44
+ Defined in: web-fetcher/dist/index.d.ts:2287
45
45
 
46
46
  Creates a new FetchSession.
47
47
 
@@ -67,7 +67,7 @@ Configuration options for the fetcher.
67
67
 
68
68
  > `protected` **closed**: `boolean`
69
69
 
70
- Defined in: web-fetcher/dist/index.d.ts:2186
70
+ Defined in: web-fetcher/dist/index.d.ts:2281
71
71
 
72
72
  #### Inherited from
73
73
 
@@ -79,7 +79,7 @@ Defined in: web-fetcher/dist/index.d.ts:2186
79
79
 
80
80
  > `readonly` **context**: `FetchContext`
81
81
 
82
- Defined in: web-fetcher/dist/index.d.ts:2185
82
+ Defined in: web-fetcher/dist/index.d.ts:2280
83
83
 
84
84
  The execution context for this session, containing configurations, event bus, and shared state.
85
85
 
@@ -93,7 +93,7 @@ The execution context for this session, containing configurations, event bus, an
93
93
 
94
94
  > `readonly` **id**: `string`
95
95
 
96
- Defined in: web-fetcher/dist/index.d.ts:2181
96
+ Defined in: web-fetcher/dist/index.d.ts:2276
97
97
 
98
98
  Unique identifier for the session.
99
99
 
@@ -107,7 +107,7 @@ Unique identifier for the session.
107
107
 
108
108
  > `protected` **options**: `FetcherOptions`
109
109
 
110
- Defined in: web-fetcher/dist/index.d.ts:2177
110
+ Defined in: web-fetcher/dist/index.d.ts:2272
111
111
 
112
112
  #### Inherited from
113
113
 
@@ -119,7 +119,7 @@ Defined in: web-fetcher/dist/index.d.ts:2177
119
119
 
120
120
  > `static` **\_isFactory**: `boolean` = `false`
121
121
 
122
- Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L33)
122
+ Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L33)
123
123
 
124
124
  ***
125
125
 
@@ -127,7 +127,7 @@ Defined in: [web-searcher/src/searcher.ts:33](https://github.com/isdk/web-search
127
127
 
128
128
  > `static` `optional` **alias**: `string` \| `string`[]
129
129
 
130
- Defined in: [web-searcher/src/searcher.ts:45](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L45)
130
+ Defined in: [web-searcher/src/searcher.ts:45](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L45)
131
131
 
132
132
  Engine alias(es). Can be a single string or an array of strings.
133
133
  Useful for registering shorthand names (e.g., 'g' for 'Google').
@@ -138,7 +138,7 @@ Useful for registering shorthand names (e.g., 'g' for 'Google').
138
138
 
139
139
  > `static` **createObject**: (`name`, ...`args`) => `WebSearcher`
140
140
 
141
- Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L78)
141
+ Defined in: [web-searcher/src/searcher.ts:78](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L78)
142
142
 
143
143
  Creates an instance of the registered search engine.
144
144
 
@@ -168,7 +168,7 @@ An instance of the search engine.
168
168
 
169
169
  > `static` **forEach**: (`cb`) => `void`
170
170
 
171
- Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L85)
171
+ Defined in: [web-searcher/src/searcher.ts:85](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L85)
172
172
 
173
173
  Iterates over all registered engines.
174
174
 
@@ -190,7 +190,7 @@ Callback function to invoke for each registered engine.
190
190
 
191
191
  > `static` **get**: (`name`) => *typeof* `WebSearcher`
192
192
 
193
- Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L69)
193
+ Defined in: [web-searcher/src/searcher.ts:69](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L69)
194
194
 
195
195
  Retrieves a registered search engine class by name.
196
196
 
@@ -214,7 +214,7 @@ The search engine class constructor.
214
214
 
215
215
  > `static` `optional` **name**: `string`
216
216
 
217
- Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L40)
217
+ Defined in: [web-searcher/src/searcher.ts:40](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L40)
218
218
 
219
219
  Custom engine name. If not provided, it is derived from the class name.
220
220
  For example, `GoogleSearcher` becomes `Google`.
@@ -225,7 +225,7 @@ For example, `GoogleSearcher` becomes `Google`.
225
225
 
226
226
  > `static` **register**: (`ctor`, `options?`) => `boolean`
227
227
 
228
- Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L54)
228
+ Defined in: [web-searcher/src/searcher.ts:54](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L54)
229
229
 
230
230
  Registers a search engine class.
231
231
 
@@ -255,7 +255,7 @@ Registration options. If a string is provided, it is used as the registered name
255
255
 
256
256
  > `static` **setAliases**: (`ctor`, ...`aliases`) => `void`
257
257
 
258
- Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L93)
258
+ Defined in: [web-searcher/src/searcher.ts:93](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L93)
259
259
 
260
260
  Sets aliases for a registered engine.
261
261
 
@@ -283,7 +283,7 @@ Aliases to add.
283
283
 
284
284
  > `static` **unregister**: (`name?`) => `void`
285
285
 
286
- Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L61)
286
+ Defined in: [web-searcher/src/searcher.ts:61](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L61)
287
287
 
288
288
  Unregisters a search engine.
289
289
 
@@ -307,7 +307,7 @@ The name or class to unregister.
307
307
 
308
308
  > **get** **pagination**(): [`PaginationConfig`](../interfaces/PaginationConfig.md) \| `undefined`
309
309
 
310
- Defined in: [web-searcher/src/searcher.ts:151](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L151)
310
+ Defined in: [web-searcher/src/searcher.ts:151](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L151)
311
311
 
312
312
  Optional pagination configuration.
313
313
  Defines how the searcher navigates to subsequent pages.
@@ -326,7 +326,7 @@ If undefined, the searcher will only fetch the first page.
326
326
 
327
327
  > **get** `abstract` **template**(): `FetcherOptions`
328
328
 
329
- Defined in: [web-searcher/src/searcher.ts:143](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L143)
329
+ Defined in: [web-searcher/src/searcher.ts:143](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L143)
330
330
 
331
331
  The declarative template for the fetch options.
332
332
 
@@ -356,7 +356,7 @@ get template() {
356
356
 
357
357
  > `protected` **createContext**(`options`): `FetchContext`
358
358
 
359
- Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L155)
359
+ Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L155)
360
360
 
361
361
  #### Parameters
362
362
 
@@ -378,7 +378,7 @@ Defined in: [web-searcher/src/searcher.ts:155](https://github.com/isdk/web-searc
378
378
 
379
379
  > **dispose**(): `Promise`\<`void`\>
380
380
 
381
- Defined in: web-fetcher/dist/index.d.ts:2251
381
+ Defined in: web-fetcher/dist/index.d.ts:2346
382
382
 
383
383
  Disposes of the session and its associated engine.
384
384
 
@@ -401,7 +401,7 @@ This method should be called when the session is no longer needed to free up res
401
401
 
402
402
  > **execute**\<`R`\>(`actionOptions`, `context?`): `Promise`\<`FetchActionResult`\<`R`\>\>
403
403
 
404
- Defined in: web-fetcher/dist/index.d.ts:2206
404
+ Defined in: web-fetcher/dist/index.d.ts:2301
405
405
 
406
406
  Executes a single action within the session.
407
407
 
@@ -449,7 +449,7 @@ await session.execute({ name: 'goto', params: { url: 'https://example.com' } });
449
449
 
450
450
  > **executeAll**(`actions`, `options?`): `Promise`\<\{ `outputs`: `Record`\<`string`, `any`\>; `result`: `FetchResponse` \| `undefined`; \}\>
451
451
 
452
- Defined in: web-fetcher/dist/index.d.ts:2223
452
+ Defined in: web-fetcher/dist/index.d.ts:2318
453
453
 
454
454
  Executes a sequence of actions.
455
455
 
@@ -493,7 +493,7 @@ const { result, outputs } = await session.executeAll([
493
493
 
494
494
  > `protected` **formatOptions**(`options`): `Record`\<`string`, `any`\>
495
495
 
496
- Defined in: [web-searcher/src/searcher.ts:308](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L308)
496
+ Defined in: [web-searcher/src/searcher.ts:312](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L312)
497
497
 
498
498
  Transforms standard options into engine-specific template variables.
499
499
 
@@ -521,7 +521,7 @@ A dictionary of variables to be injected into the template.
521
521
 
522
522
  > **getOutputs**(): `Record`\<`string`, `any`\>
523
523
 
524
- Defined in: web-fetcher/dist/index.d.ts:2234
524
+ Defined in: web-fetcher/dist/index.d.ts:2329
525
525
 
526
526
  Retrieves all outputs accumulated during the session.
527
527
 
@@ -541,7 +541,7 @@ A record of stored output data.
541
541
 
542
542
  > **getState**(): `Promise`\<\{ `cookies`: `Cookie`[]; `sessionState?`: `any`; \} \| `undefined`\>
543
543
 
544
- Defined in: web-fetcher/dist/index.d.ts:2240
544
+ Defined in: web-fetcher/dist/index.d.ts:2335
545
545
 
546
546
  Gets the current state of the session, including cookies and engine-specific state.
547
547
 
@@ -561,7 +561,7 @@ A promise resolving to the session state, or undefined if no engine is initializ
561
561
 
562
562
  > **search**(`query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
563
563
 
564
- Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L182)
564
+ Defined in: [web-searcher/src/searcher.ts:182](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L182)
565
565
 
566
566
  Executes a search query.
567
567
 
@@ -594,7 +594,7 @@ A promise resolving to an array of standardized search results.
594
594
 
595
595
  > `protected` **transform**(`outputs`, `context`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
596
596
 
597
- Defined in: [web-searcher/src/searcher.ts:290](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L290)
597
+ Defined in: [web-searcher/src/searcher.ts:294](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L294)
598
598
 
599
599
  Transform and clean the raw extracted results.
600
600
 
@@ -627,7 +627,7 @@ A promise resolving to an array of standardized search results.
627
627
 
628
628
  > `static` **search**(`engineName`, `query`, `options`): `Promise`\<[`StandardSearchResult`](../interfaces/StandardSearchResult.md)[]\>
629
629
 
630
- Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/searcher.ts#L106)
630
+ Defined in: [web-searcher/src/searcher.ts:106](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/searcher.ts#L106)
631
631
 
632
632
  Static helper to execute a one-off search.
633
633
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: CustomTimeRange
8
8
 
9
- Defined in: [web-searcher/src/types.ts:78](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L78)
9
+ Defined in: [web-searcher/src/types.ts:104](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L104)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [web-searcher/src/types.ts:78](https://github.com/isdk/web-searcher.
14
14
 
15
15
  > **from**: `string` \| `Date`
16
16
 
17
- Defined in: [web-searcher/src/types.ts:80](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L80)
17
+ Defined in: [web-searcher/src/types.ts:106](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L106)
18
18
 
19
19
  Start date (Date object or string like 'YYYY-MM-DD').
20
20
 
@@ -24,6 +24,6 @@ Start date (Date object or string like 'YYYY-MM-DD').
24
24
 
25
25
  > `optional` **to**: `string` \| `Date`
26
26
 
27
- Defined in: [web-searcher/src/types.ts:82](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L82)
27
+ Defined in: [web-searcher/src/types.ts:108](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L108)
28
28
 
29
29
  End date (Date object or string like 'YYYY-MM-DD'). Defaults to current date if omitted.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: PaginationConfig
8
8
 
9
- Defined in: [web-searcher/src/types.ts:26](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L26)
9
+ Defined in: [web-searcher/src/types.ts:41](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/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:53](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L53)
20
+ Defined in: [web-searcher/src/types.ts:68](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/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.
@@ -31,11 +31,31 @@ The increment step for each page.
31
31
 
32
32
  ***
33
33
 
34
+ ### maxPages?
35
+
36
+ > `optional` **maxPages**: `number`
37
+
38
+ Defined in: [web-searcher/src/types.ts:85](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L85)
39
+
40
+ The safety threshold for the maximum number of pages to fetch automatically
41
+ in a single search call.
42
+
43
+ Even if the requested `limit` of results hasn't been reached, the searcher
44
+ will stop after this many pages to prevent infinite loops or excessive API usage.
45
+
46
+ #### Default
47
+
48
+ ```ts
49
+ 10
50
+ ```
51
+
52
+ ***
53
+
34
54
  ### nextButtonSelector?
35
55
 
36
56
  > `optional` **nextButtonSelector**: `string`
37
57
 
38
- Defined in: [web-searcher/src/types.ts:59](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L59)
58
+ Defined in: [web-searcher/src/types.ts:74](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L74)
39
59
 
40
60
  The CSS selector for the "Next" page button.
41
61
  Required if type is 'click-next'.
@@ -46,7 +66,7 @@ Required if type is 'click-next'.
46
66
 
47
67
  > `optional` **paramName**: `string`
48
68
 
49
- Defined in: [web-searcher/src/types.ts:39](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L39)
69
+ Defined in: [web-searcher/src/types.ts:54](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L54)
50
70
 
51
71
  The name of the URL parameter used for pagination.
52
72
  Required if type is 'url-param'.
@@ -63,7 +83,7 @@ Required if type is 'url-param'.
63
83
 
64
84
  > `optional` **startValue**: `number`
65
85
 
66
- Defined in: [web-searcher/src/types.ts:45](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L45)
86
+ Defined in: [web-searcher/src/types.ts:60](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L60)
67
87
 
68
88
  The starting value for the pagination parameter.
69
89
 
@@ -79,7 +99,7 @@ The starting value for the pagination parameter.
79
99
 
80
100
  > **type**: `"url-param"` \| `"click-next"`
81
101
 
82
- Defined in: [web-searcher/src/types.ts:32](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L32)
102
+ Defined in: [web-searcher/src/types.ts:47](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L47)
83
103
 
84
104
  The type of pagination mechanism:
85
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:65](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L65)
9
+ Defined in: [web-searcher/src/types.ts:91](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L91)
10
10
 
11
11
  Context object passed to the transform function.
12
12
 
@@ -16,7 +16,7 @@ Context object passed to the transform function.
16
16
 
17
17
  > `optional` **limit**: `number`
18
18
 
19
- Defined in: [web-searcher/src/types.ts:73](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L73)
19
+ Defined in: [web-searcher/src/types.ts:99](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L99)
20
20
 
21
21
  The requested limit of results.
22
22
 
@@ -26,7 +26,7 @@ The requested limit of results.
26
26
 
27
27
  > **page**: `number`
28
28
 
29
- Defined in: [web-searcher/src/types.ts:70](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L70)
29
+ Defined in: [web-searcher/src/types.ts:96](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L96)
30
30
 
31
31
  The current page index (0-based).
32
32
 
@@ -36,6 +36,6 @@ The current page index (0-based).
36
36
 
37
37
  > **query**: `string`
38
38
 
39
- Defined in: [web-searcher/src/types.ts:67](https://github.com/isdk/web-searcher.js/blob/6ce291d521b8526526b386fab6dda19d36d0bece/src/types.ts#L67)
39
+ Defined in: [web-searcher/src/types.ts:93](https://github.com/isdk/web-searcher.js/blob/7bcd8cca4a3a7fc201a5cf3e3b4283f267eadcea/src/types.ts#L93)
40
40
 
41
41
  The original search query.