pacer/docs/installation.md at main · TanStack/pacer · GitHub
Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 2.59 KB

installation.md

File metadata and controls

81 lines (54 loc) · 2.59 KB
title Installation
id installation

Pacer packages are ESM-only, target ES2022, and require Node.js 20 or newer when running in Node.js. The Octane adapter requires Node.js 22.22.2 or newer. Ember includes a CommonJS addon metadata shim for its build tooling; its runtime entry points are ESM. Use ESM imports or dynamic import() when consuming them.

Install the adapter for your framework with your preferred package manager:

react: @tanstack/react-pacer solid: @tanstack/solid-pacer angular: @tanstack/angular-pacer preact: @tanstack/preact-pacer vue: @tanstack/vue-pacer svelte: @tanstack/svelte-pacer lit: @tanstack/lit-pacer alpine: @tanstack/alpine-pacer ember: @tanstack/ember-pacer octane: @tanstack/octane-pacer

Each framework package re-exports everything from the core @tanstack/pacer package, so you do not need to install the core package separately.

Note

Not using a framework? Install the core @tanstack/pacer package directly for vanilla JavaScript.

React

Devtools

Developer tools are available using TanStack Devtools. Install the devtools adapter and the Pacer devtools plugin as dev dependencies to inspect your pacers at runtime.

Solid

Devtools

Developer tools are available using TanStack Devtools. Install the devtools adapter and the Pacer devtools plugin as dev dependencies to inspect your pacers at runtime.

react: @tanstack/react-devtools react: @tanstack/react-pacer-devtools solid: @tanstack/solid-devtools solid: @tanstack/solid-pacer-devtools

React

See the devtools page for setup and usage.

Solid

See the devtools page for setup and usage.

Next steps

Your framework's quick start walks through a first debouncer, then covers selected state, reactive options, async work, default options, and cleanup: