Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/autofix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
persist-credentials: false
- name: Setup Tools
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
fetch-depth: 0
persist-credentials: false
Expand All @@ -40,7 +40,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
fetch-depth: 0
persist-credentials: false
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
fetch-depth: 0
persist-credentials: false
Expand All @@ -32,7 +32,7 @@ jobs:
- name: Run Tests
run: pnpm run test:ci
- name: Run Changesets (version or publish)
uses: changesets/action@63a615b9cd06ba9a3e6d13796c7fbcb080a60a0b # v1.8.0
uses: changesets/action@a45c4d594aa4e2c509dc14a9f2b3b67ba3780d0d # v1.9.0
with:
version: pnpm run changeset:version
publish: pnpm run changeset:publish
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/zizmor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
persist-credentials: false

- name: Run zizmor
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3
uses: zizmorcore/zizmor-action@3dc1ecc9bcb9e94e9b2c709687979e1298497054 # v0.6.2
with:
advanced-security: false
annotations: true
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncBatchedCallback
function injectAsyncBatchedCallback<TValue>(fn, options): (item) => Promise<void>;
```

Defined in: [angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts#L42)
Defined in: [async-batcher/injectAsyncBatchedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts#L42)

An Angular function that creates an async batched version of a callback function.
This function is essentially a wrapper around `injectAsyncBatcher` that provides
Expand Down Expand Up @@ -47,19 +47,7 @@ Consider using the `injectAsyncBatcher` function instead.

## Returns

```ts
(item): Promise<void>;
```

### Parameters

#### item

`TValue`

### Returns

`Promise`\<`void`\>
(`item`) => `Promise`\<`void`\>

## Example

Expand Down
10 changes: 5 additions & 5 deletions docs/framework/angular/reference/functions/injectAsyncBatcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ title: injectAsyncBatcher
```ts
function injectAsyncBatcher<TValue, TSelected>(
fn,
options,
selector): AngularAsyncBatcher<TValue, TSelected>;
options?,
selector?): AngularAsyncBatcher<TValue, TSelected>;
```

Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L96)
Defined in: [async-batcher/injectAsyncBatcher.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L96)

An Angular function that creates and manages an AsyncBatcher instance.

Expand Down Expand Up @@ -63,11 +63,11 @@ When using onUnmount with flush, guard your callbacks since the component may al

(`items`) => `Promise`\<`any`\>

### options
### options?

[`AngularAsyncBatcherOptions`](../interfaces/AngularAsyncBatcherOptions.md)\<`TValue`, `TSelected`\> = `{}`

### selector
### selector?

(`state`) => `TSelected`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncDebouncedCallback
function injectAsyncDebouncedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;
```

Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts#L40)
Defined in: [async-debouncer/injectAsyncDebouncedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts#L40)

An Angular function that creates an async debounced version of a callback function.
This function is essentially a wrapper around `injectAsyncDebouncer` that provides
Expand Down Expand Up @@ -48,19 +48,7 @@ Consider using the `injectAsyncDebouncer` function instead.

## Returns

```ts
(...args): Promise<Awaited<ReturnType<TFn>> | undefined>;
```

### Parameters

#### args

...`Parameters`\<`TFn`\>

### Returns

`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
(...`args`) => `Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ title: injectAsyncDebouncer
function injectAsyncDebouncer<TFn, TSelected>(
fn,
options,
selector): AngularAsyncDebouncer<TFn, TSelected>;
selector?): AngularAsyncDebouncer<TFn, TSelected>;
```

Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:119](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L119)
Defined in: [async-debouncer/injectAsyncDebouncer.ts:119](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L119)

An Angular function that creates and manages an AsyncDebouncer instance.

Expand Down Expand Up @@ -82,7 +82,7 @@ When using onUnmount with flush, guard your callbacks since the component may al

[`AngularAsyncDebouncerOptions`](../interfaces/AngularAsyncDebouncerOptions.md)\<`TFn`, `TSelected`\>

### selector
### selector?

(`state`) => `TSelected`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ title: injectAsyncQueuedSignal
```ts
function injectAsyncQueuedSignal<TValue, TSelected>(
fn,
options,
selector): AsyncQueuedSignal<TValue, TSelected>;
options?,
selector?): AsyncQueuedSignal<TValue, TSelected>;
```

Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:52](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L52)
Defined in: [async-queuer/injectAsyncQueuedSignal.ts:52](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L52)

An Angular function that creates an async queuer with managed state, combining Angular's signals with async queuing functionality.
This function provides both the current queue state and queue control methods.
Expand Down Expand Up @@ -41,11 +41,11 @@ The function returns a callable object:

(`value`) => `Promise`\<`any`\>

### options
### options?

`AsyncQueuerOptions`\<`TValue`\> = `{}`

### selector
### selector?

(`state`) => `TSelected`

Expand Down
10 changes: 5 additions & 5 deletions docs/framework/angular/reference/functions/injectAsyncQueuer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ title: injectAsyncQueuer
```ts
function injectAsyncQueuer<TValue, TSelected>(
fn,
options,
selector): AngularAsyncQueuer<TValue, TSelected>;
options?,
selector?): AngularAsyncQueuer<TValue, TSelected>;
```

Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L96)
Defined in: [async-queuer/injectAsyncQueuer.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L96)

An Angular function that creates and manages an AsyncQueuer instance.

Expand Down Expand Up @@ -63,11 +63,11 @@ When using onUnmount with flush, guard your callbacks since the component may al

(`value`) => `Promise`\<`any`\>

### options
### options?

[`AngularAsyncQueuerOptions`](../interfaces/AngularAsyncQueuerOptions.md)\<`TValue`, `TSelected`\> = `{}`

### selector
### selector?

(`state`) => `TSelected`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncRateLimitedCallback
function injectAsyncRateLimitedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;
```

Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts:43](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts#L43)
Defined in: [async-rate-limiter/injectAsyncRateLimitedCallback.ts:43](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts#L43)

An Angular function that creates an async rate-limited version of a callback function.
This function is essentially a wrapper around `injectAsyncRateLimiter` that provides
Expand Down Expand Up @@ -44,19 +44,7 @@ Consider using the `injectAsyncRateLimiter` function instead.

## Returns

```ts
(...args): Promise<Awaited<ReturnType<TFn>> | undefined>;
```

### Parameters

#### args

...`Parameters`\<`TFn`\>

### Returns

`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
(...`args`) => `Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ title: injectAsyncRateLimiter
function injectAsyncRateLimiter<TFn, TSelected>(
fn,
options,
selector): AngularAsyncRateLimiter<TFn, TSelected>;
selector?): AngularAsyncRateLimiter<TFn, TSelected>;
```

Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:83](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L83)
Defined in: [async-rate-limiter/injectAsyncRateLimiter.ts:83](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L83)

An Angular function that creates and manages an AsyncRateLimiter instance.

Expand Down Expand Up @@ -58,7 +58,7 @@ Use the `onUnmount` option to customize this.

[`AngularAsyncRateLimiterOptions`](../interfaces/AngularAsyncRateLimiterOptions.md)\<`TFn`, `TSelected`\>

### selector
### selector?

(`state`) => `TSelected`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncThrottledCallback
function injectAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;
```

Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts:41](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts#L41)
Defined in: [async-throttler/injectAsyncThrottledCallback.ts:41](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts#L41)

An Angular function that creates an async throttled version of a callback function.
This function is essentially a wrapper around `injectAsyncThrottler` that provides
Expand Down Expand Up @@ -46,19 +46,7 @@ Consider using the `injectAsyncThrottler` function instead.

## Returns

```ts
(...args): Promise<Awaited<ReturnType<TFn>> | undefined>;
```

### Parameters

#### args

...`Parameters`\<`TFn`\>

### Returns

`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
(...`args`) => `Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ title: injectAsyncThrottler
function injectAsyncThrottler<TFn, TSelected>(
fn,
options,
selector): AngularAsyncThrottler<TFn, TSelected>;
selector?): AngularAsyncThrottler<TFn, TSelected>;
```

Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:98](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L98)
Defined in: [async-throttler/injectAsyncThrottler.ts:98](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L98)

An Angular function that creates and manages an AsyncThrottler instance.

Expand Down Expand Up @@ -69,7 +69,7 @@ When using onUnmount with flush, guard your callbacks since the component may al

[`AngularAsyncThrottlerOptions`](../interfaces/AngularAsyncThrottlerOptions.md)\<`TFn`, `TSelected`\>

### selector
### selector?

(`state`) => `TSelected`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectBatchedCallback
function injectBatchedCallback<TValue>(fn, options): (item) => void;
```

Defined in: [angular-pacer/src/batcher/injectBatchedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatchedCallback.ts#L40)
Defined in: [batcher/injectBatchedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatchedCallback.ts#L40)

An Angular function that creates a batched version of a callback function.
This function is essentially a wrapper around `injectBatcher` that provides
Expand Down Expand Up @@ -46,19 +46,7 @@ Consider using the `injectBatcher` function instead.

## Returns

```ts
(item): void;
```

### Parameters

#### item

`TValue`

### Returns

`void`
(`item`) => `void`

## Example

Expand Down
10 changes: 5 additions & 5 deletions docs/framework/angular/reference/functions/injectBatcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ title: injectBatcher
```ts
function injectBatcher<TValue, TSelected>(
fn,
options,
selector): AngularBatcher<TValue, TSelected>;
options?,
selector?): AngularBatcher<TValue, TSelected>;
```

Defined in: [angular-pacer/src/batcher/injectBatcher.ts:85](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L85)
Defined in: [batcher/injectBatcher.ts:85](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L85)

An Angular function that creates and manages a Batcher instance.

Expand Down Expand Up @@ -63,11 +63,11 @@ const batcher = injectBatcher(fn, {

(`items`) => `void`

### options
### options?

[`AngularBatcherOptions`](../interfaces/AngularBatcherOptions.md)\<`TValue`, `TSelected`\> = `{}`

### selector
### selector?

(`state`) => `TSelected`

Expand Down
Loading
Loading