createPacerScope

function createPacerScope(defaultOptions?): object;

Defined in: provider/createPacerScope.ts:26

Creates typed Pacer factories sharing an Alpine lifecycle and reactive defaults.

Parameters#

defaultOptions?#

AlpinePacerOptions<PacerProviderOptions> = {}

Returns#

object

destroy#

destroy: () => void = scope.destroy;

Returns#

void

destroyed#

Get Signature#

get destroyed(): boolean;

Returns#

boolean

createAsyncBatcher()#

createAsyncBatcher<TValue, TSelected>(
   fn,
   options?,
selector?): AlpineAsyncBatcher<TValue, TSelected>;

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

fn#

(items) => Promise<any>

options?#

AlpinePacerOptions<AlpineAsyncBatcherOptions<TValue, TSelected>> = {}

selector?#

(state) => TSelected

Returns#

AlpineAsyncBatcher<TValue, TSelected>

createAsyncDebouncer()#

createAsyncDebouncer<TFn, TSelected>(
   fn,
   options,
selector?): AlpineAsyncDebouncer<TFn, TSelected>;

Type Parameters#

TFn#

TFn extends AnyAsyncFunction

TSelected#

TSelected = { }

Parameters#

fn#

TFn

options#

AlpinePacerOptions<AlpineAsyncDebouncerOptions<TFn, TSelected>>

selector?#

(state) => TSelected

Returns#

AlpineAsyncDebouncer<TFn, TSelected>

createAsyncQueuedState()#

createAsyncQueuedState<TValue, TSelected>(
   fn,
   options?,
   selector?): [() => TValue[], AlpineAsyncQueuer<TValue, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected extends Pick<AsyncQueuerState<TValue>, "items"> = Pick<AsyncQueuerState<TValue>, "items">

Parameters#

fn#

(item) => Promise<any>

options?#

AlpinePacerOptions<AlpineAsyncQueuerOptions<TValue, TSelected>> = {}

selector?#

(state) => TSelected

Returns#

[() => TValue[], AlpineAsyncQueuer<TValue, TSelected>]

createAsyncQueuer()#

createAsyncQueuer<TValue, TSelected>(
   fn,
   options?,
selector?): AlpineAsyncQueuer<TValue, TSelected>;

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

fn#

(item) => Promise<any>

options?#

AlpinePacerOptions<AlpineAsyncQueuerOptions<TValue, TSelected>> = {}

selector?#

(state) => TSelected

Returns#

AlpineAsyncQueuer<TValue, TSelected>

createAsyncRateLimiter()#

createAsyncRateLimiter<TFn, TSelected>(
   fn,
   options,
selector?): AlpineAsyncRateLimiter<TFn, TSelected>;

Type Parameters#

TFn#

TFn extends AnyAsyncFunction

TSelected#

TSelected = { }

Parameters#

fn#

TFn

options#

AlpinePacerOptions<AlpineAsyncRateLimiterOptions<TFn, TSelected>>

selector?#

(state) => TSelected

Returns#

AlpineAsyncRateLimiter<TFn, TSelected>

createAsyncThrottler()#

createAsyncThrottler<TFn, TSelected>(
   fn,
   options,
selector?): AlpineAsyncThrottler<TFn, TSelected>;

Type Parameters#

TFn#

TFn extends AnyAsyncFunction

TSelected#

TSelected = { }

Parameters#

fn#

TFn

options#

AlpinePacerOptions<AlpineAsyncThrottlerOptions<TFn, TSelected>>

selector?#

(state) => TSelected

Returns#

AlpineAsyncThrottler<TFn, TSelected>

createBatcher()#

createBatcher<TValue, TSelected>(
   fn,
   options?,
selector?): AlpineBatcher<TValue, TSelected>;

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

fn#

(items) => void

options?#

AlpinePacerOptions<AlpineBatcherOptions<TValue, TSelected>> = {}

selector?#

(state) => TSelected

Returns#

AlpineBatcher<TValue, TSelected>

createDebouncedState()#

createDebouncedState<TValue, TSelected>(
   initialValue,
   options,
   selector?): [CellValue<TValue>, SetValue<TValue>, AlpineDebouncer<SetValue<TValue>, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

initialValue#

TValue

options#

AlpinePacerOptions<AlpineDebouncerOptions<SetValue<TValue>, TSelected>>

selector?#

(state) => TSelected

Returns#

[CellValue<TValue>, SetValue<TValue>, AlpineDebouncer<SetValue<TValue>, TSelected>]

createDebouncedValue()#

createDebouncedValue<TValue, TSelected>(
   source,
   options,
   selector?): [CellValue<TValue>, AlpineDebouncer<SetValue<TValue>, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

source#

ValueSource<TValue>

options#

AlpinePacerOptions<AlpineDebouncerOptions<SetValue<TValue>, TSelected>>

selector?#

(state) => TSelected

Returns#

[CellValue<TValue>, AlpineDebouncer<SetValue<TValue>, TSelected>]

createDebouncer()#

createDebouncer<TFn, TSelected>(
   fn,
   options,
selector?): AlpineDebouncer<TFn, TSelected>;

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Parameters#

fn#

TFn

options#

AlpinePacerOptions<AlpineDebouncerOptions<TFn, TSelected>>

selector?#

(state) => TSelected

Returns#

AlpineDebouncer<TFn, TSelected>

createQueuedState()#

createQueuedState<TValue, TSelected>(
   fn,
   options?,
   selector?): [() => TValue[], (item, position?, runOnItemsChange?) => boolean, AlpineQueuer<TValue, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected extends Pick<QueuerState<TValue>, "items"> = Pick<QueuerState<TValue>, "items">

Parameters#

fn#

(item) => void

options?#

AlpinePacerOptions<AlpineQueuerOptions<TValue, TSelected>> = {}

selector?#

(state) => TSelected

Returns#

[() => TValue[], (item, position?, runOnItemsChange?) => boolean, AlpineQueuer<TValue, TSelected>]

createQueuedValue()#

createQueuedValue<TValue, TSelected>(
   source,
   options?,
   selector?): [CellValue<TValue>, AlpineQueuer<TValue, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

source#

ValueSource<TValue>

options?#

AlpinePacerOptions<AlpineQueuerOptions<TValue, TSelected>> = {}

selector?#

(state) => TSelected

Returns#

[CellValue<TValue>, AlpineQueuer<TValue, TSelected>]

createQueuer()#

createQueuer<TValue, TSelected>(
   fn,
   options?,
selector?): AlpineQueuer<TValue, TSelected>;

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

fn#

(item) => void

options?#

AlpinePacerOptions<AlpineQueuerOptions<TValue, TSelected>> = {}

selector?#

(state) => TSelected

Returns#

AlpineQueuer<TValue, TSelected>

createRateLimitedState()#

createRateLimitedState<TValue, TSelected>(
   initialValue,
   options,
   selector?): [CellValue<TValue>, SetValue<TValue>, AlpineRateLimiter<SetValue<TValue>, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

initialValue#

TValue

options#

AlpinePacerOptions<AlpineRateLimiterOptions<SetValue<TValue>, TSelected>>

selector?#

(state) => TSelected

Returns#

[CellValue<TValue>, SetValue<TValue>, AlpineRateLimiter<SetValue<TValue>, TSelected>]

createRateLimitedValue()#

createRateLimitedValue<TValue, TSelected>(
   source,
   options,
   selector?): [CellValue<TValue>, AlpineRateLimiter<SetValue<TValue>, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

source#

ValueSource<TValue>

options#

AlpinePacerOptions<AlpineRateLimiterOptions<SetValue<TValue>, TSelected>>

selector?#

(state) => TSelected

Returns#

[CellValue<TValue>, AlpineRateLimiter<SetValue<TValue>, TSelected>]

createRateLimiter()#

createRateLimiter<TFn, TSelected>(
   fn,
   options,
selector?): AlpineRateLimiter<TFn, TSelected>;

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Parameters#

fn#

TFn

options#

AlpinePacerOptions<AlpineRateLimiterOptions<TFn, TSelected>>

selector?#

(state) => TSelected

Returns#

AlpineRateLimiter<TFn, TSelected>

createThrottledState()#

createThrottledState<TValue, TSelected>(
   initialValue,
   options,
   selector?): [CellValue<TValue>, SetValue<TValue>, AlpineThrottler<SetValue<TValue>, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

initialValue#

TValue

options#

AlpinePacerOptions<AlpineThrottlerOptions<SetValue<TValue>, TSelected>>

selector?#

(state) => TSelected

Returns#

[CellValue<TValue>, SetValue<TValue>, AlpineThrottler<SetValue<TValue>, TSelected>]

createThrottledValue()#

createThrottledValue<TValue, TSelected>(
   source,
   options,
   selector?): [CellValue<TValue>, AlpineThrottler<SetValue<TValue>, TSelected>];

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Parameters#

source#

ValueSource<TValue>

options#

AlpinePacerOptions<AlpineThrottlerOptions<SetValue<TValue>, TSelected>>

selector?#

(state) => TSelected

Returns#

[CellValue<TValue>, AlpineThrottler<SetValue<TValue>, TSelected>]

createThrottler()#

createThrottler<TFn, TSelected>(
   fn,
   options,
selector?): AlpineThrottler<TFn, TSelected>;

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Parameters#

fn#

TFn

options#

AlpinePacerOptions<AlpineThrottlerOptions<TFn, TSelected>>

selector?#

(state) => TSelected

Returns#

AlpineThrottler<TFn, TSelected>