Open History to see the last commit
1---
2id: createPacerScope
3title: createPacerScope
4---
5
6```ts
7function createPacerScope(defaultOptions?): object;
8```
9
10Defined in: [provider/createPacerScope.ts:26](https://github.com/TanStack/pacer/blob/main/packages/alpine-pacer/src/provider/createPacerScope.ts#L26)
11
12Creates typed Pacer factories sharing an Alpine lifecycle and reactive defaults.
13
14## Parameters
15
16### defaultOptions?
17
18[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`PacerProviderOptions`](../interfaces/PacerProviderOptions.md)\> = `{}`
19
20## Returns
21
22`object`
23
24### destroy
25
26```ts
27destroy: () => void = scope.destroy;
28```
29
30#### Returns
31
32`void`
33
34### destroyed
35
36#### Get Signature
37
38```ts
39get destroyed(): boolean;
40```
41
42##### Returns
43
44`boolean`
45
46### createAsyncBatcher()
47
48```ts
49createAsyncBatcher<TValue, TSelected>(
50 fn,
51 options?,
52selector?): AlpineAsyncBatcher<TValue, TSelected>;
53```
54
55#### Type Parameters
56
57##### TValue
58
59`TValue`
60
61##### TSelected
62
63`TSelected` = \{
64\}
65
66#### Parameters
67
68##### fn
69
70(`items`) => `Promise`\<`any`\>
71
72##### options?
73
74[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineAsyncBatcherOptions`](../interfaces/AlpineAsyncBatcherOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
75
76##### selector?
77
78(`state`) => `TSelected`
79
80#### Returns
81
82[`AlpineAsyncBatcher`](../interfaces/AlpineAsyncBatcher.md)\<`TValue`, `TSelected`\>
83
84### createAsyncDebouncer()
85
86```ts
87createAsyncDebouncer<TFn, TSelected>(
88 fn,
89 options,
90selector?): AlpineAsyncDebouncer<TFn, TSelected>;
91```
92
93#### Type Parameters
94
95##### TFn
96
97`TFn` *extends* `AnyAsyncFunction`
98
99##### TSelected
100
101`TSelected` = \{
102\}
103
104#### Parameters
105
106##### fn
107
108`TFn`
109
110##### options
111
112[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineAsyncDebouncerOptions`](../interfaces/AlpineAsyncDebouncerOptions.md)\<`TFn`, `TSelected`\>\>
113
114##### selector?
115
116(`state`) => `TSelected`
117
118#### Returns
119
120[`AlpineAsyncDebouncer`](../interfaces/AlpineAsyncDebouncer.md)\<`TFn`, `TSelected`\>
121
122### createAsyncQueuedState()
123
124```ts
125createAsyncQueuedState<TValue, TSelected>(
126 fn,
127 options?,
128 selector?): [() => TValue[], AlpineAsyncQueuer<TValue, TSelected>];
129```
130
131#### Type Parameters
132
133##### TValue
134
135`TValue`
136
137##### TSelected
138
139`TSelected` *extends* `Pick`\<`AsyncQueuerState`\<`TValue`\>, `"items"`\> = `Pick`\<`AsyncQueuerState`\<`TValue`\>, `"items"`\>
140
141#### Parameters
142
143##### fn
144
145(`item`) => `Promise`\<`any`\>
146
147##### options?
148
149[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineAsyncQueuerOptions`](../interfaces/AlpineAsyncQueuerOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
150
151##### selector?
152
153(`state`) => `TSelected`
154
155#### Returns
156
157\[() => `TValue`[], [`AlpineAsyncQueuer`](../interfaces/AlpineAsyncQueuer.md)\<`TValue`, `TSelected`\>\]
158
159### createAsyncQueuer()
160
161```ts
162createAsyncQueuer<TValue, TSelected>(
163 fn,
164 options?,
165selector?): AlpineAsyncQueuer<TValue, TSelected>;
166```
167
168#### Type Parameters
169
170##### TValue
171
172`TValue`
173
174##### TSelected
175
176`TSelected` = \{
177\}
178
179#### Parameters
180
181##### fn
182
183(`item`) => `Promise`\<`any`\>
184
185##### options?
186
187[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineAsyncQueuerOptions`](../interfaces/AlpineAsyncQueuerOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
188
189##### selector?
190
191(`state`) => `TSelected`
192
193#### Returns
194
195[`AlpineAsyncQueuer`](../interfaces/AlpineAsyncQueuer.md)\<`TValue`, `TSelected`\>
196
197### createAsyncRateLimiter()
198
199```ts
200createAsyncRateLimiter<TFn, TSelected>(
201 fn,
202 options,
203selector?): AlpineAsyncRateLimiter<TFn, TSelected>;
204```
205
206#### Type Parameters
207
208##### TFn
209
210`TFn` *extends* `AnyAsyncFunction`
211
212##### TSelected
213
214`TSelected` = \{
215\}
216
217#### Parameters
218
219##### fn
220
221`TFn`
222
223##### options
224
225[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineAsyncRateLimiterOptions`](../interfaces/AlpineAsyncRateLimiterOptions.md)\<`TFn`, `TSelected`\>\>
226
227##### selector?
228
229(`state`) => `TSelected`
230
231#### Returns
232
233[`AlpineAsyncRateLimiter`](../interfaces/AlpineAsyncRateLimiter.md)\<`TFn`, `TSelected`\>
234
235### createAsyncThrottler()
236
237```ts
238createAsyncThrottler<TFn, TSelected>(
239 fn,
240 options,
241selector?): AlpineAsyncThrottler<TFn, TSelected>;
242```
243
244#### Type Parameters
245
246##### TFn
247
248`TFn` *extends* `AnyAsyncFunction`
249
250##### TSelected
251
252`TSelected` = \{
253\}
254
255#### Parameters
256
257##### fn
258
259`TFn`
260
261##### options
262
263[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineAsyncThrottlerOptions`](../interfaces/AlpineAsyncThrottlerOptions.md)\<`TFn`, `TSelected`\>\>
264
265##### selector?
266
267(`state`) => `TSelected`
268
269#### Returns
270
271[`AlpineAsyncThrottler`](../interfaces/AlpineAsyncThrottler.md)\<`TFn`, `TSelected`\>
272
273### createBatcher()
274
275```ts
276createBatcher<TValue, TSelected>(
277 fn,
278 options?,
279selector?): AlpineBatcher<TValue, TSelected>;
280```
281
282#### Type Parameters
283
284##### TValue
285
286`TValue`
287
288##### TSelected
289
290`TSelected` = \{
291\}
292
293#### Parameters
294
295##### fn
296
297(`items`) => `void`
298
299##### options?
300
301[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineBatcherOptions`](../interfaces/AlpineBatcherOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
302
303##### selector?
304
305(`state`) => `TSelected`
306
307#### Returns
308
309[`AlpineBatcher`](../interfaces/AlpineBatcher.md)\<`TValue`, `TSelected`\>
310
311### createDebouncedState()
312
313```ts
314createDebouncedState<TValue, TSelected>(
315 initialValue,
316 options,
317 selector?): [CellValue<TValue>, SetValue<TValue>, AlpineDebouncer<SetValue<TValue>, TSelected>];
318```
319
320#### Type Parameters
321
322##### TValue
323
324`TValue`
325
326##### TSelected
327
328`TSelected` = \{
329\}
330
331#### Parameters
332
333##### initialValue
334
335`TValue`
336
337##### options
338
339[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineDebouncerOptions`](../interfaces/AlpineDebouncerOptions.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\>
340
341##### selector?
342
343(`state`) => `TSelected`
344
345#### Returns
346
347\[`CellValue`\<`TValue`\>, `SetValue`\<`TValue`\>, [`AlpineDebouncer`](../interfaces/AlpineDebouncer.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\]
348
349### createDebouncedValue()
350
351```ts
352createDebouncedValue<TValue, TSelected>(
353 source,
354 options,
355 selector?): [CellValue<TValue>, AlpineDebouncer<SetValue<TValue>, TSelected>];
356```
357
358#### Type Parameters
359
360##### TValue
361
362`TValue`
363
364##### TSelected
365
366`TSelected` = \{
367\}
368
369#### Parameters
370
371##### source
372
373`ValueSource`\<`TValue`\>
374
375##### options
376
377[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineDebouncerOptions`](../interfaces/AlpineDebouncerOptions.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\>
378
379##### selector?
380
381(`state`) => `TSelected`
382
383#### Returns
384
385\[`CellValue`\<`TValue`\>, [`AlpineDebouncer`](../interfaces/AlpineDebouncer.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\]
386
387### createDebouncer()
388
389```ts
390createDebouncer<TFn, TSelected>(
391 fn,
392 options,
393selector?): AlpineDebouncer<TFn, TSelected>;
394```
395
396#### Type Parameters
397
398##### TFn
399
400`TFn` *extends* `AnyFunction`
401
402##### TSelected
403
404`TSelected` = \{
405\}
406
407#### Parameters
408
409##### fn
410
411`TFn`
412
413##### options
414
415[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineDebouncerOptions`](../interfaces/AlpineDebouncerOptions.md)\<`TFn`, `TSelected`\>\>
416
417##### selector?
418
419(`state`) => `TSelected`
420
421#### Returns
422
423[`AlpineDebouncer`](../interfaces/AlpineDebouncer.md)\<`TFn`, `TSelected`\>
424
425### createQueuedState()
426
427```ts
428createQueuedState<TValue, TSelected>(
429 fn,
430 options?,
431 selector?): [() => TValue[], (item, position?, runOnItemsChange?) => boolean, AlpineQueuer<TValue, TSelected>];
432```
433
434#### Type Parameters
435
436##### TValue
437
438`TValue`
439
440##### TSelected
441
442`TSelected` *extends* `Pick`\<`QueuerState`\<`TValue`\>, `"items"`\> = `Pick`\<`QueuerState`\<`TValue`\>, `"items"`\>
443
444#### Parameters
445
446##### fn
447
448(`item`) => `void`
449
450##### options?
451
452[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineQueuerOptions`](../interfaces/AlpineQueuerOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
453
454##### selector?
455
456(`state`) => `TSelected`
457
458#### Returns
459
460\[() => `TValue`[], (`item`, `position?`, `runOnItemsChange?`) => `boolean`, [`AlpineQueuer`](../interfaces/AlpineQueuer.md)\<`TValue`, `TSelected`\>\]
461
462### createQueuedValue()
463
464```ts
465createQueuedValue<TValue, TSelected>(
466 source,
467 options?,
468 selector?): [CellValue<TValue>, AlpineQueuer<TValue, TSelected>];
469```
470
471#### Type Parameters
472
473##### TValue
474
475`TValue`
476
477##### TSelected
478
479`TSelected` = \{
480\}
481
482#### Parameters
483
484##### source
485
486`ValueSource`\<`TValue`\>
487
488##### options?
489
490[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineQueuerOptions`](../interfaces/AlpineQueuerOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
491
492##### selector?
493
494(`state`) => `TSelected`
495
496#### Returns
497
498\[`CellValue`\<`TValue`\>, [`AlpineQueuer`](../interfaces/AlpineQueuer.md)\<`TValue`, `TSelected`\>\]
499
500### createQueuer()
501
502```ts
503createQueuer<TValue, TSelected>(
504 fn,
505 options?,
506selector?): AlpineQueuer<TValue, TSelected>;
507```
508
509#### Type Parameters
510
511##### TValue
512
513`TValue`
514
515##### TSelected
516
517`TSelected` = \{
518\}
519
520#### Parameters
521
522##### fn
523
524(`item`) => `void`
525
526##### options?
527
528[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineQueuerOptions`](../interfaces/AlpineQueuerOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
529
530##### selector?
531
532(`state`) => `TSelected`
533
534#### Returns
535
536[`AlpineQueuer`](../interfaces/AlpineQueuer.md)\<`TValue`, `TSelected`\>
537
538### createRateLimitedState()
539
540```ts
541createRateLimitedState<TValue, TSelected>(
542 initialValue,
543 options,
544 selector?): [CellValue<TValue>, SetValue<TValue>, AlpineRateLimiter<SetValue<TValue>, TSelected>];
545```
546
547#### Type Parameters
548
549##### TValue
550
551`TValue`
552
553##### TSelected
554
555`TSelected` = \{
556\}
557
558#### Parameters
559
560##### initialValue
561
562`TValue`
563
564##### options
565
566[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineRateLimiterOptions`](../interfaces/AlpineRateLimiterOptions.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\>
567
568##### selector?
569
570(`state`) => `TSelected`
571
572#### Returns
573
574\[`CellValue`\<`TValue`\>, `SetValue`\<`TValue`\>, [`AlpineRateLimiter`](../interfaces/AlpineRateLimiter.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\]
575
576### createRateLimitedValue()
577
578```ts
579createRateLimitedValue<TValue, TSelected>(
580 source,
581 options,
582 selector?): [CellValue<TValue>, AlpineRateLimiter<SetValue<TValue>, TSelected>];
583```
584
585#### Type Parameters
586
587##### TValue
588
589`TValue`
590
591##### TSelected
592
593`TSelected` = \{
594\}
595
596#### Parameters
597
598##### source
599
600`ValueSource`\<`TValue`\>
601
602##### options
603
604[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineRateLimiterOptions`](../interfaces/AlpineRateLimiterOptions.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\>
605
606##### selector?
607
608(`state`) => `TSelected`
609
610#### Returns
611
612\[`CellValue`\<`TValue`\>, [`AlpineRateLimiter`](../interfaces/AlpineRateLimiter.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\]
613
614### createRateLimiter()
615
616```ts
617createRateLimiter<TFn, TSelected>(
618 fn,
619 options,
620selector?): AlpineRateLimiter<TFn, TSelected>;
621```
622
623#### Type Parameters
624
625##### TFn
626
627`TFn` *extends* `AnyFunction`
628
629##### TSelected
630
631`TSelected` = \{
632\}
633
634#### Parameters
635
636##### fn
637
638`TFn`
639
640##### options
641
642[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineRateLimiterOptions`](../interfaces/AlpineRateLimiterOptions.md)\<`TFn`, `TSelected`\>\>
643
644##### selector?
645
646(`state`) => `TSelected`
647
648#### Returns
649
650[`AlpineRateLimiter`](../interfaces/AlpineRateLimiter.md)\<`TFn`, `TSelected`\>
651
652### createThrottledState()
653
654```ts
655createThrottledState<TValue, TSelected>(
656 initialValue,
657 options,
658 selector?): [CellValue<TValue>, SetValue<TValue>, AlpineThrottler<SetValue<TValue>, TSelected>];
659```
660
661#### Type Parameters
662
663##### TValue
664
665`TValue`
666
667##### TSelected
668
669`TSelected` = \{
670\}
671
672#### Parameters
673
674##### initialValue
675
676`TValue`
677
678##### options
679
680[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineThrottlerOptions`](../interfaces/AlpineThrottlerOptions.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\>
681
682##### selector?
683
684(`state`) => `TSelected`
685
686#### Returns
687
688\[`CellValue`\<`TValue`\>, `SetValue`\<`TValue`\>, [`AlpineThrottler`](../interfaces/AlpineThrottler.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\]
689
690### createThrottledValue()
691
692```ts
693createThrottledValue<TValue, TSelected>(
694 source,
695 options,
696 selector?): [CellValue<TValue>, AlpineThrottler<SetValue<TValue>, TSelected>];
697```
698
699#### Type Parameters
700
701##### TValue
702
703`TValue`
704
705##### TSelected
706
707`TSelected` = \{
708\}
709
710#### Parameters
711
712##### source
713
714`ValueSource`\<`TValue`\>
715
716##### options
717
718[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineThrottlerOptions`](../interfaces/AlpineThrottlerOptions.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\>
719
720##### selector?
721
722(`state`) => `TSelected`
723
724#### Returns
725
726\[`CellValue`\<`TValue`\>, [`AlpineThrottler`](../interfaces/AlpineThrottler.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\]
727
728### createThrottler()
729
730```ts
731createThrottler<TFn, TSelected>(
732 fn,
733 options,
734selector?): AlpineThrottler<TFn, TSelected>;
735```
736
737#### Type Parameters
738
739##### TFn
740
741`TFn` *extends* `AnyFunction`
742
743##### TSelected
744
745`TSelected` = \{
746\}
747
748#### Parameters
749
750##### fn
751
752`TFn`
753
754##### options
755
756[`AlpinePacerOptions`](../type-aliases/AlpinePacerOptions.md)\<[`AlpineThrottlerOptions`](../interfaces/AlpineThrottlerOptions.md)\<`TFn`, `TSelected`\>\>
757
758##### selector?
759
760(`state`) => `TSelected`
761
762#### Returns
763
764[`AlpineThrottler`](../interfaces/AlpineThrottler.md)\<`TFn`, `TSelected`\>