Skip to content

Commit 746e16f

Browse files
KevinVandyghostd
authored andcommitted
chore: new installation docs and uninstall tanstack store-core from angular adapter
1 parent 8ab49d9 commit 746e16f

13 files changed

Lines changed: 41 additions & 50 deletions

File tree

docs/installation.md

Lines changed: 30 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,54 @@ title: Installation
33
id: installation
44
---
55

6-
You can install TanStack Pacer with any [NPM](https://npmjs.com) package manager.
6+
TanStack Pacer is compatible with various front-end frameworks. Install the corresponding adapter for your framework using your preferred package manager:
77

8-
Only install one of the following packages depending on your use case:
8+
<!-- ::start:tabs variant="package-managers" -->
99

10-
## React
10+
react: @tanstack/react-pacer
11+
solid: @tanstack/solid-pacer
12+
angular: @tanstack/angular-pacer
1113

12-
```sh
13-
npm install @tanstack/react-pacer
14-
```
14+
<!-- ::end:tabs -->
1515

16-
TanStack Pacer is compatible with React v16.8+
16+
Each framework package re-exports everything from the core `@tanstack/pacer` package, so there is no need to install the core package separately.
1717

18-
## Solid
18+
> [!NOTE]
19+
> If you are not using a framework, you can install the core `@tanstack/pacer` package directly for use with vanilla JavaScript.
1920
20-
```sh
21-
npm install @tanstack/solid-pacer
22-
```
21+
<!-- ::start:framework -->
2322

24-
TanStack Pacer is compatible with Solid v1.9.5+
23+
# React
2524

26-
## Angular
25+
## Devtools
2726

28-
```sh
29-
npm install @tanstack/angular-pacer
30-
```
27+
Developer tools are available using [TanStack Devtools](https://tanstack.com/devtools/latest). Install the devtools adapter and the Pacer devtools plugin as dev dependencies to inspect and monitor your pacers.
3128

32-
TanStack Pacer is compatible with Angular v16+
29+
# Solid
3330

34-
## Vanilla JS
31+
## Devtools
3532

36-
```sh
37-
npm install @tanstack/pacer
38-
```
33+
Developer tools are available using [TanStack Devtools](https://tanstack.com/devtools/latest). Install the devtools adapter and the Pacer devtools plugin as dev dependencies to inspect and monitor your pacers.
3934

40-
Install the the core `@tanstack/pacer` package to use with any framework or without a framework. Each framework package up above will also re-export everything from this core package.
35+
<!-- ::end:framework -->
4136

42-
> [!IMPORTANT]
43-
> There's no need to install the `@tanstack/pacer` core package if you've already installed one of the above framework packages.
37+
<!-- ::start:tabs variant="package-manager" -->
4438

45-
## Devtools (Optional)
39+
react: @tanstack/react-devtools
40+
react: @tanstack/react-pacer-devtools
41+
solid: @tanstack/solid-devtools
42+
solid: @tanstack/solid-pacer-devtools
4643

47-
To use the devtools for debugging and monitoring, install both the framework devtools and the Pacer devtools packages:
44+
<!-- ::end:tabs -->
4845

49-
### React Devtools
46+
<!-- ::start:framework -->
5047

51-
```sh
52-
npm install @tanstack/react-devtools @tanstack/react-pacer-devtools
53-
```
48+
# React
5449

55-
### Solid Devtools
50+
See the [devtools](./devtools) documentation for more information on how to set up and use the Pacer devtools.
5651

57-
```sh
58-
npm install @tanstack/solid-devtools @tanstack/solid-pacer-devtools
59-
```
52+
# Solid
6053

61-
See the [devtools](https://pacer.tanstack.com/docs/devtools) documentation for more information on how to set up and use the Pacer devtools.
54+
See the [devtools](./devtools) documentation for more information on how to set up and use the Pacer devtools.
55+
56+
<!-- ::end:framework -->

packages/angular-pacer/package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,7 @@
108108
],
109109
"dependencies": {
110110
"@tanstack/angular-store": "^0.8.0",
111-
"@tanstack/pacer": "workspace:*",
112-
"@tanstack/store": "^0.8.0"
111+
"@tanstack/pacer": "workspace:*"
113112
},
114113
"devDependencies": {
115114
"@angular/core": "^21.0.0",

packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { AsyncBatcher } from '@tanstack/pacer/async-batcher'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type {
77
AsyncBatcherOptions,
88
AsyncBatcherState,

packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type { AnyAsyncFunction } from '@tanstack/pacer/types'
77
import type {
88
AsyncDebouncerOptions,

packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { AsyncQueuer } from '@tanstack/pacer/async-queuer'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type {
77
AsyncQueuerOptions,
88
AsyncQueuerState,

packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type { AnyAsyncFunction } from '@tanstack/pacer/types'
77
import type {
88
AsyncRateLimiterOptions,

packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { AsyncThrottler } from '@tanstack/pacer/async-throttler'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type { AnyAsyncFunction } from '@tanstack/pacer/types'
77
import type {
88
AsyncThrottlerOptions,

packages/angular-pacer/src/batcher/injectBatcher.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { Batcher } from '@tanstack/pacer/batcher'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'
77

88
export interface AngularBatcher<TValue, TSelected = {}> extends Omit<

packages/angular-pacer/src/debouncer/injectDebouncer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { Debouncer } from '@tanstack/pacer/debouncer'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type { AnyFunction } from '@tanstack/pacer/types'
77
import type {
88
DebouncerOptions,

packages/angular-pacer/src/queuer/injectQueuer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { injectStore } from '@tanstack/angular-store'
22
import { Queuer } from '@tanstack/pacer/queuer'
33
import { injectPacerOptions } from '../provider/pacer-context'
44
import type { Signal } from '@angular/core'
5-
import type { Store } from '@tanstack/store'
5+
import type { Store } from '@tanstack/angular-store'
66
import type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'
77

88
export interface AngularQueuer<TValue, TSelected = {}> extends Omit<

0 commit comments

Comments
 (0)