Skip to content

Commit 808abae

Browse files
theVedantaautofix-ci[bot]KevinVandy
authored andcommitted
chore: docs + types improved for Angular (#155)
* adapter.md + Signals now typed without & object * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Kevin Van Cott <kevinvandy656@gmail.com>
1 parent 4d4d5a2 commit 808abae

65 files changed

Lines changed: 428 additions & 366 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/framework/angular/adapter.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,20 @@ import { Component, signal } from '@angular/core'
2424
import { injectDebouncer } from '@tanstack/angular-pacer'
2525

2626
@Component({
27-
selector: 'app-search',
27+
selector: 'app-root',
2828
template: `
2929
<input [value]="query()" (input)="onInput($event)" placeholder="Search..." />
3030
<p>Pending: {{ debouncer.state().isPending }}</p>
31+
<p>Debounced: {{ debounced() }}</p>
3132
`,
3233
})
33-
export class SearchComponent {
34+
export class App {
3435
protected readonly query = signal('')
36+
protected readonly debounced = signal('')
3537

3638
protected readonly debouncer = injectDebouncer(
3739
(q: string) => {
38-
console.log('Searching for', q)
40+
this.debounced.set(q)
3941
},
4042
{ wait: 500 },
4143
(state) => ({ isPending: state.isPending }),
@@ -82,7 +84,7 @@ The third argument to each inject function is a state selector. It determines wh
8284
**By default, if you omit the selector, `state()` is not populated.** Pass a selector to opt in to reactive state.
8385

8486
```ts
85-
// No selector: state() is not useful for reactivity
87+
// No selector: state() is not populated
8688
const debouncer = injectDebouncer(fn, { wait: 500 })
8789

8890
// With selector: state() is a signal of the selected slice

docs/framework/angular/reference/functions/injectAsyncBatchedCallback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: injectAsyncBatchedCallback
99
function injectAsyncBatchedCallback<TValue>(fn, options): (item) => Promise<void>;
1010
```
1111

12-
Defined in: [async-batcher/injectAsyncBatchedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts#L42)
12+
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)
1313

1414
An Angular function that creates an async batched version of a callback function.
1515
This function is essentially a wrapper around `injectAsyncBatcher` that provides

docs/framework/angular/reference/functions/injectAsyncBatcher.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function injectAsyncBatcher<TValue, TSelected>(
1212
selector): AngularAsyncBatcher<TValue, TSelected>;
1313
```
1414

15-
Defined in: [async-batcher/injectAsyncBatcher.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L96)
15+
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)
1616

1717
An Angular function that creates and manages an AsyncBatcher instance.
1818

docs/framework/angular/reference/functions/injectAsyncDebouncedCallback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: injectAsyncDebouncedCallback
99
function injectAsyncDebouncedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;
1010
```
1111

12-
Defined in: [async-debouncer/injectAsyncDebouncedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts#L40)
12+
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)
1313

1414
An Angular function that creates an async debounced version of a callback function.
1515
This function is essentially a wrapper around `injectAsyncDebouncer` that provides

docs/framework/angular/reference/functions/injectAsyncDebouncer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function injectAsyncDebouncer<TFn, TSelected>(
1212
selector): AngularAsyncDebouncer<TFn, TSelected>;
1313
```
1414

15-
Defined in: [async-debouncer/injectAsyncDebouncer.ts:119](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L119)
15+
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)
1616

1717
An Angular function that creates and manages an AsyncDebouncer instance.
1818

docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function injectAsyncQueuedSignal<TValue, TSelected>(
1212
selector): AsyncQueuedSignal<TValue, TSelected>;
1313
```
1414

15-
Defined in: [async-queuer/injectAsyncQueuedSignal.ts:60](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L60)
15+
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)
1616

1717
An Angular function that creates an async queuer with managed state, combining Angular's signals with async queuing functionality.
1818
This function provides both the current queue state and queue control methods.
@@ -51,7 +51,7 @@ The function returns a callable object:
5151

5252
## Returns
5353

54-
[`AsyncQueuedSignal`](../type-aliases/AsyncQueuedSignal.md)\<`TValue`, `TSelected`\>
54+
[`AsyncQueuedSignal`](../interfaces/AsyncQueuedSignal.md)\<`TValue`, `TSelected`\>
5555

5656
## Example
5757

docs/framework/angular/reference/functions/injectAsyncQueuer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function injectAsyncQueuer<TValue, TSelected>(
1212
selector): AngularAsyncQueuer<TValue, TSelected>;
1313
```
1414

15-
Defined in: [async-queuer/injectAsyncQueuer.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L96)
15+
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)
1616

1717
An Angular function that creates and manages an AsyncQueuer instance.
1818

docs/framework/angular/reference/functions/injectAsyncRateLimitedCallback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: injectAsyncRateLimitedCallback
99
function injectAsyncRateLimitedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;
1010
```
1111

12-
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)
12+
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)
1313

1414
An Angular function that creates an async rate-limited version of a callback function.
1515
This function is essentially a wrapper around `injectAsyncRateLimiter` that provides

docs/framework/angular/reference/functions/injectAsyncRateLimiter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function injectAsyncRateLimiter<TFn, TSelected>(
1212
selector): AngularAsyncRateLimiter<TFn, TSelected>;
1313
```
1414

15-
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)
15+
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)
1616

1717
An Angular function that creates and manages an AsyncRateLimiter instance.
1818

docs/framework/angular/reference/functions/injectAsyncThrottledCallback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: injectAsyncThrottledCallback
99
function injectAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;
1010
```
1111

12-
Defined in: [async-throttler/injectAsyncThrottledCallback.ts:41](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts#L41)
12+
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)
1313

1414
An Angular function that creates an async throttled version of a callback function.
1515
This function is essentially a wrapper around `injectAsyncThrottler` that provides

0 commit comments

Comments
 (0)