Skip to content

Commit 77d3f95

Browse files
ci: apply automated fixes
1 parent f0488fb commit 77d3f95

18 files changed

+73
-71
lines changed

docs/framework/preact/reference/functions/useAsyncDebouncedCallback.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: useAsyncDebouncedCallback
66
# Function: useAsyncDebouncedCallback()
77

88
```ts
9-
function useAsyncDebouncedCallback<TFn>(fn, options): (...args) => Promise<ReturnType<TFn>>;
9+
function useAsyncDebouncedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>>>;
1010
```
1111

1212
Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts:44](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts#L44)
@@ -49,7 +49,7 @@ Consider using the `useAsyncDebouncer` hook instead.
4949
## Returns
5050

5151
```ts
52-
(...args): Promise<ReturnType<TFn>>;
52+
(...args): Promise<Awaited<ReturnType<TFn>>>;
5353
```
5454

5555
### Parameters
@@ -60,7 +60,7 @@ Consider using the `useAsyncDebouncer` hook instead.
6060

6161
### Returns
6262

63-
`Promise`\<`ReturnType`\<`TFn`\>\>
63+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\>
6464

6565
## Example
6666

docs/framework/preact/reference/functions/useAsyncRateLimitedCallback.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: useAsyncRateLimitedCallback
66
# Function: useAsyncRateLimitedCallback()
77

88
```ts
9-
function useAsyncRateLimitedCallback<TFn>(fn, options): (...args) => Promise<ReturnType<TFn>>;
9+
function useAsyncRateLimitedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>>>;
1010
```
1111

1212
Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts:59](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts#L59)
@@ -63,7 +63,7 @@ Consider using the `useAsyncRateLimiter` hook instead.
6363
## Returns
6464

6565
```ts
66-
(...args): Promise<ReturnType<TFn>>;
66+
(...args): Promise<Awaited<ReturnType<TFn>>>;
6767
```
6868

6969
### Parameters
@@ -74,7 +74,7 @@ Consider using the `useAsyncRateLimiter` hook instead.
7474

7575
### Returns
7676

77-
`Promise`\<`ReturnType`\<`TFn`\>\>
77+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\>
7878

7979
## Example
8080

docs/framework/preact/reference/functions/useAsyncThrottledCallback.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: useAsyncThrottledCallback
66
# Function: useAsyncThrottledCallback()
77

88
```ts
9-
function useAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<ReturnType<TFn>>;
9+
function useAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>>>;
1010
```
1111

1212
Defined in: [preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts#L42)
@@ -50,7 +50,7 @@ Consider using the `useAsyncThrottler` hook instead.
5050
## Returns
5151

5252
```ts
53-
(...args): Promise<ReturnType<TFn>>;
53+
(...args): Promise<Awaited<ReturnType<TFn>>>;
5454
```
5555

5656
### Parameters
@@ -61,7 +61,7 @@ Consider using the `useAsyncThrottler` hook instead.
6161

6262
### Returns
6363

64-
`Promise`\<`ReturnType`\<`TFn`\>\>
64+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\>
6565

6666
## Example
6767

docs/framework/react/reference/functions/useAsyncDebouncedCallback.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: useAsyncDebouncedCallback
66
# Function: useAsyncDebouncedCallback()
77

88
```ts
9-
function useAsyncDebouncedCallback<TFn>(fn, options): (...args) => Promise<ReturnType<TFn>>;
9+
function useAsyncDebouncedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>>>;
1010
```
1111

1212
Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts:44](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts#L44)
@@ -49,7 +49,7 @@ Consider using the `useAsyncDebouncer` hook instead.
4949
## Returns
5050

5151
```ts
52-
(...args): Promise<ReturnType<TFn>>;
52+
(...args): Promise<Awaited<ReturnType<TFn>>>;
5353
```
5454

5555
### Parameters
@@ -60,7 +60,7 @@ Consider using the `useAsyncDebouncer` hook instead.
6060

6161
### Returns
6262

63-
`Promise`\<`ReturnType`\<`TFn`\>\>
63+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\>
6464

6565
## Example
6666

docs/framework/react/reference/functions/useAsyncRateLimitedCallback.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: useAsyncRateLimitedCallback
66
# Function: useAsyncRateLimitedCallback()
77

88
```ts
9-
function useAsyncRateLimitedCallback<TFn>(fn, options): (...args) => Promise<ReturnType<TFn>>;
9+
function useAsyncRateLimitedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>>>;
1010
```
1111

1212
Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts:59](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts#L59)
@@ -63,7 +63,7 @@ Consider using the `useAsyncRateLimiter` hook instead.
6363
## Returns
6464

6565
```ts
66-
(...args): Promise<ReturnType<TFn>>;
66+
(...args): Promise<Awaited<ReturnType<TFn>>>;
6767
```
6868

6969
### Parameters
@@ -74,7 +74,7 @@ Consider using the `useAsyncRateLimiter` hook instead.
7474

7575
### Returns
7676

77-
`Promise`\<`ReturnType`\<`TFn`\>\>
77+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\>
7878

7979
## Example
8080

docs/framework/react/reference/functions/useAsyncThrottledCallback.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: useAsyncThrottledCallback
66
# Function: useAsyncThrottledCallback()
77

88
```ts
9-
function useAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<ReturnType<TFn>>;
9+
function useAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>>>;
1010
```
1111

1212
Defined in: [react-pacer/src/async-throttler/useAsyncThrottledCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottledCallback.ts#L42)
@@ -50,7 +50,7 @@ Consider using the `useAsyncThrottler` hook instead.
5050
## Returns
5151

5252
```ts
53-
(...args): Promise<ReturnType<TFn>>;
53+
(...args): Promise<Awaited<ReturnType<TFn>>>;
5454
```
5555

5656
### Parameters
@@ -61,7 +61,7 @@ Consider using the `useAsyncThrottler` hook instead.
6161

6262
### Returns
6363

64-
`Promise`\<`ReturnType`\<`TFn`\>\>
64+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\>
6565

6666
## Example
6767

docs/reference/classes/AsyncDebouncer.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Defined in: [async-debouncer.ts:219](https://github.com/TanStack/pacer/blob/main
149149
abort(): void;
150150
```
151151

152-
Defined in: [async-debouncer.ts:465](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L465)
152+
Defined in: [async-debouncer.ts:467](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L467)
153153

154154
Aborts all ongoing executions with the internal abort controllers.
155155
Does NOT cancel any pending execution that have not started yet.
@@ -166,7 +166,7 @@ Does NOT cancel any pending execution that have not started yet.
166166
cancel(): void;
167167
```
168168

169-
Defined in: [async-debouncer.ts:477](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L477)
169+
Defined in: [async-debouncer.ts:479](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L479)
170170

171171
Cancels any pending execution that have not started yet.
172172
Does NOT abort any execution already in progress.
@@ -180,16 +180,16 @@ Does NOT abort any execution already in progress.
180180
### flush()
181181

182182
```ts
183-
flush(): Promise<ReturnType<TFn> | undefined>;
183+
flush(): Promise<Awaited<ReturnType<TFn>> | undefined>;
184184
```
185185

186-
Defined in: [async-debouncer.ts:400](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L400)
186+
Defined in: [async-debouncer.ts:402](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L402)
187187

188188
Processes the current pending execution immediately
189189

190190
#### Returns
191191

192-
`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\>
192+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
193193

194194
***
195195

@@ -199,7 +199,7 @@ Processes the current pending execution immediately
199199
getAbortSignal(maybeExecuteCount?): AbortSignal | null;
200200
```
201201
202-
Defined in: [async-debouncer.ts:455](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L455)
202+
Defined in: [async-debouncer.ts:457](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L457)
203203
204204
Returns the AbortSignal for a specific execution.
205205
If no maybeExecuteCount is provided, returns the signal for the most recent execution.
@@ -237,7 +237,7 @@ const debouncer = new AsyncDebouncer(
237237
### maybeExecute()
238238
239239
```ts
240-
maybeExecute(...args): Promise<ReturnType<TFn> | undefined>;
240+
maybeExecute(...args): Promise<Awaited<ReturnType<TFn>> | undefined>;
241241
```
242242
243243
Defined in: [async-debouncer.ts:314](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L314)
@@ -260,7 +260,7 @@ Error Handling:
260260
261261
#### Returns
262262
263-
`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\>
263+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
264264
265265
A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError
266266
@@ -276,7 +276,7 @@ The error from the debounced function if no onError handler is configured
276276
reset(): void;
277277
```
278278
279-
Defined in: [async-debouncer.ts:485](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L485)
279+
Defined in: [async-debouncer.ts:487](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L487)
280280
281281
Resets the debouncer state to its default values
282282

docs/reference/classes/AsyncRateLimiter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ Returns the number of remaining executions allowed in the current window
258258
### maybeExecute()
259259
260260
```ts
261-
maybeExecute(...args): Promise<ReturnType<TFn> | undefined>;
261+
maybeExecute(...args): Promise<Awaited<ReturnType<TFn>> | undefined>;
262262
```
263263
264264
Defined in: [async-rate-limiter.ts:354](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L354)
@@ -281,7 +281,7 @@ Error Handling:
281281
282282
#### Returns
283283
284-
`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\>
284+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
285285
286286
A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError
287287

docs/reference/classes/AsyncThrottler.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Defined in: [async-throttler.ts:231](https://github.com/TanStack/pacer/blob/main
153153
abort(): void;
154154
```
155155

156-
Defined in: [async-throttler.ts:529](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L529)
156+
Defined in: [async-throttler.ts:531](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L531)
157157

158158
Aborts all ongoing executions with the internal abort controllers.
159159
Does NOT cancel any pending execution that have not started yet.
@@ -170,7 +170,7 @@ Does NOT cancel any pending execution that have not started yet.
170170
cancel(): void;
171171
```
172172

173-
Defined in: [async-throttler.ts:539](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L539)
173+
Defined in: [async-throttler.ts:541](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L541)
174174

175175
Cancels any pending execution that have not started yet.
176176
Does NOT abort any execution already in progress.
@@ -184,16 +184,16 @@ Does NOT abort any execution already in progress.
184184
### flush()
185185

186186
```ts
187-
flush(): Promise<ReturnType<TFn> | undefined>;
187+
flush(): Promise<Awaited<ReturnType<TFn>> | undefined>;
188188
```
189189

190-
Defined in: [async-throttler.ts:458](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L458)
190+
Defined in: [async-throttler.ts:460](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L460)
191191

192192
Processes the current pending execution immediately
193193

194194
#### Returns
195195

196-
`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\>
196+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
197197

198198
***
199199

@@ -203,7 +203,7 @@ Processes the current pending execution immediately
203203
getAbortSignal(maybeExecuteCount?): AbortSignal | null;
204204
```
205205
206-
Defined in: [async-throttler.ts:519](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L519)
206+
Defined in: [async-throttler.ts:521](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L521)
207207
208208
Returns the AbortSignal for a specific execution.
209209
If no maybeExecuteCount is provided, returns the signal for the most recent execution.
@@ -245,7 +245,7 @@ const throttler = new AsyncThrottler(
245245
### maybeExecute()
246246
247247
```ts
248-
maybeExecute(...args): Promise<ReturnType<TFn> | undefined>;
248+
maybeExecute(...args): Promise<Awaited<ReturnType<TFn>> | undefined>;
249249
```
250250
251251
Defined in: [async-throttler.ts:334](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L334)
@@ -268,7 +268,7 @@ Attempts to execute the throttled function. The execution behavior depends on th
268268
269269
#### Returns
270270
271-
`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\>
271+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
272272
273273
#### Example
274274
@@ -290,7 +290,7 @@ await throttled.maybeExecute('c', 'd');
290290
reset(): void;
291291
```
292292
293-
Defined in: [async-throttler.ts:553](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L553)
293+
Defined in: [async-throttler.ts:555](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L555)
294294
295295
Resets the debouncer state to its default values
296296

docs/reference/functions/asyncDebounce.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ title: asyncDebounce
66
# Function: asyncDebounce()
77

88
```ts
9-
function asyncDebounce<TFn>(fn, initialOptions): (...args) => Promise<ReturnType<TFn> | undefined>;
9+
function asyncDebounce<TFn>(fn, initialOptions): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;
1010
```
1111

12-
Defined in: [async-debouncer.ts:555](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L555)
12+
Defined in: [async-debouncer.ts:557](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L557)
1313

1414
Creates an async debounced function that delays execution until after a specified wait time.
1515
The debounced function will only execute once the wait period has elapsed without any new calls.
@@ -75,7 +75,7 @@ State Management:
7575
## Returns
7676

7777
```ts
78-
(...args): Promise<ReturnType<TFn> | undefined>;
78+
(...args): Promise<Awaited<ReturnType<TFn>> | undefined>;
7979
```
8080

8181
Attempts to execute the debounced function.
@@ -96,7 +96,7 @@ Error Handling:
9696

9797
### Returns
9898

99-
`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\>
99+
`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\>
100100

101101
A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError
102102

0 commit comments

Comments
 (0)