Skip to content

Commit 15f1ac1

Browse files
committed
rename to TanStack Pacer
1 parent 02bfb5b commit 15f1ac1

File tree

164 files changed

+367
-335
lines changed

Some content is hidden

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

164 files changed

+367
-335
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,24 @@ body:
66
value: |
77
Thank you for reporting an issue :pray:.
88
9-
This issue tracker is for reporting reproducible bugs or regression's found in [react-bouncer](https://github.com/tanstack/bouncer)
9+
This issue tracker is for reporting reproducible bugs or regression's found in [react-pacer](https://github.com/tanstack/pacer)
1010
If you have a question about how to achieve or implement something and are struggling, please post a question
11-
inside of react-bouncer's [Discussions tab](https://github.com/tanstack/bouncer/discussions) instead of filing an issue.
11+
inside of react-pacer's [Discussions tab](https://github.com/tanstack/pacer/discussions) instead of filing an issue.
1212
1313
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
14-
- TanStack Bouncer's [Discussions tab](https://github.com/tanstack/bouncer/discussions)
15-
- TanStack Bouncer's [Open Issues](https://github.com/tanstack/bouncer/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
16-
- TanStack Bouncer's [Closed Issues](https://github.com/tanstack/bouncer/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
14+
- TanStack Pacer's [Discussions tab](https://github.com/tanstack/pacer/discussions)
15+
- TanStack Pacer's [Open Issues](https://github.com/tanstack/pacer/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
16+
- TanStack Pacer's [Closed Issues](https://github.com/tanstack/pacer/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
1717
1818
The more information you fill in, the better the community can help you.
1919
2020
- type: input
21-
id: tanstack-bouncer-version
21+
id: tanstack-pacer-version
2222
attributes:
23-
label: TanStack Bouncer version
23+
label: TanStack Pacer version
2424
description: |
25-
- Please let us know the exact version of the TanStack Bouncer framework adapter that you were using when the issue occurred. If you are using an older version, check to see if your bug has already been solved in the latest version. Please don't just put in "latest", as this is subject to change.
26-
- The latest "bouncer" version is <img alt="" src="https://badgen.net/npm/v/@tanstack/react-bouncer" />
25+
- Please let us know the exact version of the TanStack Pacer framework adapter that you were using when the issue occurred. If you are using an older version, check to see if your bug has already been solved in the latest version. Please don't just put in "latest", as this is subject to change.
26+
- The latest "pacer" version is <img alt="" src="https://badgen.net/npm/v/@tanstack/react-pacer" />
2727
placeholder: |
2828
e.g. v8.11.6
2929
validations:
@@ -57,7 +57,7 @@ body:
5757
- Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than React.
5858
- To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
5959
- Please make sure the example is complete and runnable without prior dependencies and free of unnecessary abstractions
60-
- Feel free to fork any of the official CodeSandbox examples to reproduce your issue: https://github.com/tanstack/bouncer/tree/main/examples/
60+
- Feel free to fork any of the official CodeSandbox examples to reproduce your issue: https://github.com/tanstack/pacer/tree/main/examples/
6161
- For React Native, you can use: https://snack.expo.dev/
6262
- For TypeScript related issues only, a TypeScript Playground link might be sufficient: https://www.typescriptlang.org/play
6363
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ permissions:
2323
jobs:
2424
test-and-publish:
2525
name: Test & Publish
26-
if: github.repository == 'TanStack/bouncer'
26+
if: github.repository == 'TanStack/pacer'
2727
runs-on: ubuntu-latest
2828
steps:
2929
- name: Checkout

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ id: contributing
77

88
## Questions
99

10-
If you have questions about implementation details, help or support, then please use our dedicated community forum at [Github Discussions](https://github.com/tanstack/bouncer/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum.
10+
If you have questions about implementation details, help or support, then please use our dedicated community forum at [Github Discussions](https://github.com/tanstack/pacer/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum.
1111

1212
## Reporting Issues
1313

14-
If you have found what you think is a bug, please [file an issue](https://github.com/tanstack/bouncer/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [Github Discussions](https://github.com/tanstack/bouncer/discussions)
14+
If you have found what you think is a bug, please [file an issue](https://github.com/tanstack/pacer/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [Github Discussions](https://github.com/tanstack/pacer/discussions)
1515

1616
## Suggesting new features
1717

README.md

+24-22
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
![TanStack Bouncer Header](https://github.com/tanstack/bouncer/raw/main/media/repo-header.png)
1+
![TanStack Pacer Header](https://github.com/tanstack/pacer/raw/main/media/repo-header.png)
22

3-
# [TanStack](https://tanstack.com) Bouncer v1
3+
# [TanStack](https://tanstack.com) Pacer v1
44

5-
Utilities for debouncing, throttling, scheduling, queuing, and more.
5+
Utilities for debouncing, throttling, queuing, and more.
66

77
<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="\_parent">
88
<img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack" />
99
</a>
10-
<a href="https://github.com/tanstack/bouncer/actions?bouncer=workflow%3A%22react-bouncer+tests%22">
11-
<img src="https://github.com/tanstack/bouncer/workflows/react-bouncer%20tests/badge.svg" />
10+
<a href="https://github.com/tanstack/pacer/actions?pacer=workflow%3A%22react-pacer+tests%22">
11+
<img src="https://github.com/tanstack/pacer/workflows/react-pacer%20tests/badge.svg" />
1212
</a>
13-
<a href="https://npmjs.com/package/@tanstack/react-bouncer" target="\_parent">
14-
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/react-bouncer.svg" />
13+
<a href="https://npmjs.com/package/@tanstack/react-pacer" target="\_parent">
14+
<img alt="" src="https://img.shields.io/npm/dm/@tanstack/react-pacer.svg" />
1515
</a>
16-
<a href="https://bundlephobia.com/result?p=@tanstack/react-bouncer@latest" target="\_parent">
17-
<img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-bouncer@latest" />
16+
<a href="https://bundlephobia.com/result?p=@tanstack/react-pacer@latest" target="\_parent">
17+
<img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-pacer@latest" />
1818
</a>
1919
<a href="#badge">
2020
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
2121
</a>
22-
<a href="https://github.com/tanstack/bouncer/discussions">
22+
<a href="https://github.com/tanstack/pacer/discussions">
2323
<img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
2424
</a>
25-
<a href="https://github.com/tanstack/bouncer" target="\_parent">
26-
<img alt="" src="https://img.shields.io/github/stars/tanstack/react-bouncer.svg?style=social&label=Star" />
25+
<a href="https://github.com/tanstack/pacer" target="\_parent">
26+
<img alt="" src="https://img.shields.io/github/stars/tanstack/react-pacer.svg?style=social&label=Star" />
2727
</a>
2828
<a href="https://twitter.com/tannerlinsley" target="\_parent">
2929
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
@@ -39,33 +39,35 @@ Try other [TanStack](https://tanstack.com) libraries:
3939
- [TanStack Virtual](https://github.com/TanStack/virtual) <img alt="" src="https://img.shields.io/github/stars/tanstack/virtual.svg" />
4040
- [TanStack Form](https://github.com/TanStack/form) <img alt="" src="https://img.shields.io/github/stars/tanstack/form.svg" />
4141
- [TanStack Ranger](https://github.com/TanStack/ranger) <img alt="" src="https://img.shields.io/github/stars/tanstack/ranger.svg" />
42-
- [TanStack Bouncer](https://github.com/TanStack/bouncer) <img alt="" src="https://img.shields.io/github/stars/tanstack/bouncer.svg" />
42+
- [TanStack Pacer](https://github.com/TanStack/pacer) <img alt="" src="https://img.shields.io/github/stars/tanstack/pacer.svg" />
4343

4444
## Visit [tanstack.com/table](https://tanstack.com/table) for docs, guides, API and more!
4545

46-
You may know **TanSack Bouncer** by our adapter names, too!
46+
You may know **TanSack Pacer** by our adapter names, too!
4747

48-
- [**React Bouncer**](https://tanstack.com/bouncer/v1/docs/framework/react/react-bouncer)
48+
- [**React Pacer**](https://tanstack.com/pacer/v1/docs/framework/react/react-pacer)
49+
- [**Solid Pacer**](https://tanstack.com/pacer/v1/docs/framework/solid/solid-pacer)
4950

5051
## Summary
5152

52-
TanStack Bouncer is a framework agnostic utility library that provides powerful debouncing, throttling, and scheduling capabilities, with framework specific adapters for major frameworks like React, Solid, Vue, Angular, and Svelte.
53+
TanStack Pacer is a framework agnostic utility library that provides powerful debouncing, throttling, and scheduling capabilities, with framework specific adapters for major frameworks like React, Solid, Vue, Angular, and Svelte.
5354

5455
## Quick Features
5556

56-
- [Debounce](https://tanstack.com/bouncer/v0/docs/framework/react/react-bouncer#debounce)
57-
- [Throttle](https://tanstack.com/bouncer/v0/docs/framework/react/react-bouncer#throttle)
58-
- [Schedule](https://tanstack.com/bouncer/v0/docs/framework/react/react-bouncer#schedule)
59-
- [Queue](https://tanstack.com/bouncer/v0/docs/framework/react/react-bouncer#queue)
57+
- [Debounce](https://tanstack.com/pacer/v0/docs/framework/react/react-pacer#debounce)
58+
- [Throttle](https://tanstack.com/pacer/v0/docs/framework/react/react-pacer#throttle)
59+
- [Schedule](https://tanstack.com/pacer/v0/docs/framework/react/react-pacer#schedule)
60+
- [Queue](https://tanstack.com/pacer/v0/docs/framework/react/react-pacer#queue)
6061

6162
## Installation
6263

6364
Install one of the following packages based on your framework of choice:
6465

6566
```bash
6667
# Npm
67-
npm install @tanstack/react-bouncer
68-
npm install @tanstack/bouncer # no framework, just vanilla js
68+
npm install @tanstack/react-pacer
69+
npm install @tanstack/solid-pacer
70+
npm install @tanstack/pacer # no framework, just vanilla js
6971
```
7072

7173
## How to help?

docs/config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"docSearch": {
44
"appId": "",
55
"apiKey": "",
6-
"indexName": "tanstack-bouncer"
6+
"indexName": "tanstack-pacer"
77
},
88
"sections": [
99
{

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ function useDebouncedState<TValue>(value, options): readonly [TValue, (...args)
1515
}]
1616
```
1717

18-
Defined in: [react-bouncer/src/useDebouncedState.ts:5](https://github.com/TanStack/bouncer/blob/main/packages/react-bouncer/src/useDebouncedState.ts#L5)
18+
Defined in: [react-pacer/src/useDebouncedState.ts:5](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/useDebouncedState.ts#L5)
1919

2020
## Type Parameters
2121

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ function useDebouncedValue<TValue>(value, options): readonly [TValue, {
1515
}]
1616
```
1717

18-
Defined in: [react-bouncer/src/useDebouncedValue.ts:5](https://github.com/TanStack/bouncer/blob/main/packages/react-bouncer/src/useDebouncedValue.ts#L5)
18+
Defined in: [react-pacer/src/useDebouncedValue.ts:5](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/useDebouncedValue.ts#L5)
1919

2020
## Type Parameters
2121

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useDebouncer
1111
function useDebouncer<TFn, TArgs>(fn, options): object
1212
```
1313

14-
Defined in: [react-bouncer/src/useDebouncer.ts:5](https://github.com/TanStack/bouncer/blob/main/packages/react-bouncer/src/useDebouncer.ts#L5)
14+
Defined in: [react-pacer/src/useDebouncer.ts:5](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/useDebouncer.ts#L5)
1515

1616
## Type Parameters
1717

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ function useThrottledState<TValue>(value, options): readonly [TValue, (...args)
1515
}]
1616
```
1717

18-
Defined in: react-bouncer/src/useThrottledState.ts:5
18+
Defined in: react-pacer/src/useThrottledState.ts:5
1919

2020
## Type Parameters
2121

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ function useThrottledValue<TValue>(value, options): readonly [TValue, {
1515
}]
1616
```
1717

18-
Defined in: react-bouncer/src/useThrottledValue.ts:5
18+
Defined in: react-pacer/src/useThrottledValue.ts:5
1919

2020
## Type Parameters
2121

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useThrottler
1111
function useThrottler<TFn, TArgs>(fn, options): object
1212
```
1313

14-
Defined in: react-bouncer/src/useThrottler.ts:5
14+
Defined in: react-pacer/src/useThrottler.ts:5
1515

1616
## Type Parameters
1717

docs/framework/react/reference/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
id: "@tanstack/react-bouncer"
3-
title: "@tanstack/react-bouncer"
2+
id: "@tanstack/react-pacer"
3+
title: "@tanstack/react-pacer"
44
---
55

66
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
77

8-
# @tanstack/react-bouncer
8+
# @tanstack/react-pacer
99

1010
## Functions
1111

docs/installation.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,44 @@ title: Installation
33
id: installation
44
---
55

6-
You can install TanStack Bouncer with any [NPM](https://npmjs.com) package manager.
6+
You can install TanStack Pacer with any [NPM](https://npmjs.com) package manager.
77

88
## React
99

1010
```sh
11-
npm install @tanstack/react-bouncer
11+
npm install @tanstack/react-pacer
1212
```
1313

14-
TanStack Bouncer is compatible with React v16.8+
14+
TanStack Pacer is compatible with React v16.8+
1515

1616
## Vue
1717

1818
```sh
19-
npm install @tanstack/vue-bouncer
19+
npm install @tanstack/vue-pacer
2020
```
2121

22-
TanStack Bouncer is compatible with Vue 2 and 3.
22+
TanStack Pacer is compatible with Vue 2 and 3.
2323

2424
## Angular
2525

2626
```sh
27-
npm install @tanstack/angular-bouncer
27+
npm install @tanstack/angular-pacer
2828
```
2929

30-
TanStack Bouncer is compatible with Angular 19+
30+
TanStack Pacer is compatible with Angular 19+
3131

3232
## SolidJS
3333

3434
```sh
35-
npm install @tanstack/solid-bouncer
35+
npm install @tanstack/solid-pacer
3636
```
3737

38-
TanStack Bouncer is compatible with Solid and SolidStart.
38+
TanStack Pacer is compatible with Solid and SolidStart.
3939

4040
## Svelte
4141

4242
```sh
43-
npm install @tanstack/svelte-bouncer
43+
npm install @tanstack/svelte-pacer
4444
```
4545

46-
TanStack Bouncer is compatible with Svelte 5.
46+
TanStack Pacer is compatible with Svelte 5.

docs/overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ title: Overview
33
id: overview
44
---
55

6-
TanStack Bouncer is a framework agnostic utility library that provides powerful debouncing, throttling, and scheduling capabilities, with framework specific adapters for major frameworks like React, Solid, Vue, Angular, and Svelte.
6+
TanStack Pacer is a framework agnostic utility library that provides powerful debouncing, throttling, and scheduling capabilities, with framework specific adapters for major frameworks like React, Solid, Vue, Angular, and Svelte.
77

8-
TanStack Bouncer is designed to help you control the rate of function execution and manage timing-based operations efficiently across any framework or application. It can be used as a standalone library or integrated seamlessly with other TanStack products.
8+
TanStack Pacer is designed to help you control the rate of function execution and manage timing-based operations efficiently across any framework or application. It can be used as a standalone library or integrated seamlessly with other TanStack products.

docs/reference/classes/debouncer.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Debouncer
77

88
# Class: Debouncer\<TFn, TArgs\>
99

10-
Defined in: [debouncer.ts:24](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L24)
10+
Defined in: [debouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L24)
1111

1212
A class that creates a debounced function.
1313

@@ -25,7 +25,7 @@ A class that creates a debounced function.
2525
new Debouncer<TFn, TArgs>(fn, options): Debouncer<TFn, TArgs>
2626
```
2727

28-
Defined in: [debouncer.ts:33](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L33)
28+
Defined in: [debouncer.ts:33](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L33)
2929

3030
#### Parameters
3131

@@ -49,7 +49,7 @@ Defined in: [debouncer.ts:33](https://github.com/TanStack/bouncer/blob/main/pack
4949
cancel(): void
5050
```
5151

52-
Defined in: [debouncer.ts:81](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L81)
52+
Defined in: [debouncer.ts:81](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L81)
5353

5454
Cancels any pending execution
5555

@@ -65,7 +65,7 @@ Cancels any pending execution
6565
execute(...args): void
6666
```
6767

68-
Defined in: [debouncer.ts:54](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L54)
68+
Defined in: [debouncer.ts:54](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L54)
6969

7070
Executes the debounced function
7171

@@ -87,7 +87,7 @@ Executes the debounced function
8787
getExecutionCount(): number
8888
```
8989

90-
Defined in: [debouncer.ts:47](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L47)
90+
Defined in: [debouncer.ts:47](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L47)
9191

9292
Returns the number of times the function has been executed
9393

docs/reference/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
id: "@tanstack/bouncer"
3-
title: "@tanstack/bouncer"
2+
id: "@tanstack/pacer"
3+
title: "@tanstack/pacer"
44
---
55

66
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
77

8-
# @tanstack/bouncer
8+
# @tanstack/pacer
99

1010
## Classes
1111

docs/reference/interfaces/debounceroptions.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: DebouncerOptions
77

88
# Interface: DebouncerOptions
99

10-
Defined in: [debouncer.ts:4](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L4)
10+
Defined in: [debouncer.ts:4](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L4)
1111

1212
Options for configuring a debounced function
1313

@@ -19,7 +19,7 @@ Options for configuring a debounced function
1919
optional leading: boolean;
2020
```
2121

22-
Defined in: [debouncer.ts:13](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L13)
22+
Defined in: [debouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L13)
2323

2424
Whether to execute on the leading edge of the timeout.
2525
Defaults to false.
@@ -32,7 +32,7 @@ Defaults to false.
3232
optional trailing: boolean;
3333
```
3434

35-
Defined in: [debouncer.ts:18](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L18)
35+
Defined in: [debouncer.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L18)
3636

3737
Whether to execute on the trailing edge of the timeout.
3838
Defaults to true. Setting to false will only let functions execute on the leading edge if `leading` is also set to true.
@@ -45,6 +45,6 @@ Defaults to true. Setting to false will only let functions execute on the leadin
4545
wait: number;
4646
```
4747

48-
Defined in: [debouncer.ts:8](https://github.com/TanStack/bouncer/blob/main/packages/bouncer/src/debouncer.ts#L8)
48+
Defined in: [debouncer.ts:8](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L8)
4949

5050
Delay in milliseconds before executing the function

0 commit comments

Comments
 (0)