# @solid-primitives/scheduled > Primitives for creating scheduled — throttled or debounced — callbacks. Latest version **1.5.3** (published 2026-02-21) · MIT license · 0 weekly downloads ## Install ```sh npm install @solid-primitives/scheduled pnpm add @solid-primitives/scheduled yarn add @solid-primitives/scheduled bun add @solid-primitives/scheduled ``` ## Health **Score 65/100 (B)** — status: stable. Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 1.5.3 | | Published | 2026-02-21 | | First published | 2022-05-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM | | Dependencies | 0 | | Unpacked size | 23 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1558 | | Maintainers | davedbase, lexlohr, thetarnav. | | Keywords | solid, primitives, scheduled, debounce, throttle | ## Links - npm: https://www.npmjs.com/package/@solid-primitives/scheduled - Repository: https://github.com/solidjs-community/solid-primitives - Homepage: https://primitives.solidjs.community/package/scheduled - Issues: https://github.com/solidjs-community/solid-primitives/issues - npm.io page: https://npm.io/package/@solid-primitives/scheduled ## Alternatives - [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads - [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads - [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads - [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads - [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads ## Recent versions - 1.5.3 (latest) — 2026-02-21 - 2.0.0-next.2 (next) — 2026-08-12 - 2.0.0-next.1 — 2026-07-18 - 2.0.0-next.0 — 2026-06-26 - 1.5.2 — 2025-06-29 - 1.5.1 — 2025-04-27 - 1.5.0 — 2025-01-22 - 1.4.4 — 2024-10-27 - 1.4.3 — 2024-03-05 - 1.4.2 — 2024-01-16 - 1.4.1 — 2023-08-07 - 1.4.0 — 2023-07-18 - 1.3.2 — 2023-03-23 - 1.3.1 — 2023-02-28 - 1.3.0 — 2023-02-20 - … 6 more at https://npm.io/package/@solid-primitives/scheduled/versions ## README

Solid Primitives Scheduled

# @solid-primitives/scheduled [![size](https://img.shields.io/bundlephobia/minzip/@solid-primitives/scheduled?style=for-the-badge&label=size)](https://bundlephobia.com/package/@solid-primitives/scheduled) [![version](https://img.shields.io/npm/v/@solid-primitives/scheduled?style=for-the-badge)](https://www.npmjs.com/package/@solid-primitives/scheduled) [![stage](https://img.shields.io/endpoint?style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolidjs-community%2Fsolid-primitives%2Fmain%2Fassets%2Fbadges%2Fstage-2.json)](https://github.com/solidjs-community/solid-primitives#contribution-process) Primitives for creating scheduled — throttled or debounced — callbacks. - [`debounce`](#debounce) - Creates a callback that is **debounced** and cancellable. - [`throttle`](#throttle) - Creates a callback that is **throttled** and cancellable. - [`scheduleIdle`](#scheduleidle) - Creates a callback throttled using `window.requestIdleCallback()`. - [`leading`](#leading) - Creates a scheduled and cancellable callback that will be called on **leading** edge. - [`createScheduled`](#createscheduled) - Creates a signal used for scheduling execution of solid computations by tracking. - [Scheduling explanation](#scheduling-explanation) ## Installation ```bash npm install @solid-primitives/scheduled # or yarn add @solid-primitives/scheduled ``` ## `debounce` Creates a callback that is debounced and cancellable. The debounced callback is called on **trailing** edge. The timeout will be automatically cleared on root dispose. ### How to use it ```ts import { debounce } from "@solid-primitives/scheduled"; const trigger = debounce((message: string) => console.log(message), 250); trigger("Hello!"); trigger.clear(); // clears a timeout in progress ``` ## `throttle` Creates a callback that is throttled and cancellable. The throttled callback is called on **trailing** edge. The timeout will be automatically cleared on root dispose. ### How to use it ```ts import { throttle } from "@solid-primitives/scheduled"; const trigger = throttle((message: string) => console.log(message), 250); trigger("Hello!"); trigger.clear(); // clears a timeout in progress ``` ## `scheduleIdle` Creates a callback throttled using `window.requestIdleCallback()`. ([MDN reference](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback)) The throttled callback is called on **trailing** edge. The timeout will be automatically cleared on root dispose. > **Note:** `requestIdleCallback` is not available in Safari. If it's not available, `scheduleIdle` will fallback to `throttle` with default timeout. (callbacks will be batched using setTimeout instead) ### How to use it ```ts import { scheduleIdle } from "@solid-primitives/scheduled"; const trigger = scheduleIdle( (message: string) => console.log(message), // timeout passed to requestIdleCallback is a maximum timeout before the callback is called 250, ); trigger("Hello!"); trigger.clear(); // clears a timeout in progress ``` ## `leading` Creates a scheduled and cancellable callback that will be called on **leading** edge. The timeout will be automatically cleared on root dispose. ### How to use it ```ts // with debounce import { leading, debounce } from "@solid-primitives/scheduled"; const trigger = leading(debounce, (message: string) => console.log(message), 250); trigger("Hello!"); trigger.clear(); // clears a timeout in progress // with throttle import { leading, throttle } from "@solid-primitives/scheduled"; const trigger = leading(throttle, (message: string) => console.log(message), 250); trigger("Hello!"); trigger.clear(); // clears a timeout in progress ``` ## `leadingAndTrailing` Creates a scheduled and cancellable callback that will be called on **leading** edge for the first call, and **trailing** edge thereafter. The timeout will be automatically cleared on root dispose. ### How to use it ```ts // with debounce import { leadingAndTrailing, debounce } from "@solid-primitives/scheduled"; const trigger = leadingAndTrailing(debounce, (message: string) => console.log(message), 250); trigger("Hello!"); trigger.clear(); // clears a timeout in progress // with throttle import { leadingAndTrailing, throttle } from "@solid-primitives/scheduled"; const trigger = leadingAndTrailing(throttle, (message: string) => console.log(message), 250); trigger("Hello!"); trigger.clear(); // clears a timeout in progress ``` ## `createScheduled` Creates a signal used for scheduling execution of solid computations by tracking. ### How to use it `createScheduled` takes only one parameter - a `schedule` function. This function is called with a callback that should be scheduled. It should return a function for triggering the timeout. ```ts // e.g. with debounce createScheduled(fn => debounce(fn, 1000)); // e.g. with throttle createScheduled(fn => throttle(fn, 1000)); // e.g. with leading debounce createScheduled(fn => leading(debounce, fn, 1000)); // e.g. with leading throttle createScheduled(fn => leading(throttle, fn, 1000)); ``` It returns a signal that can be used to schedule execution of a solid computation. The signal returns `true` if it's dirty _(callback should be called)_ and `false` otherwise. ```ts import { createScheduled, debounce } from "@solid-primitives/scheduled"; const scheduled = createScheduled(fn => debounce(fn, 1000)); const [count, setCount] = createSignal(0); createEffect(() => { // track source signal const value = count(); // track the debounced signal and check if it's dirty if (scheduled()) { console.log("count", value); } }); // or with createMemo const debouncedCount = createMemo((p: number = 0) => { // track source signal const value = count(); // track the debounced signal and check if it's dirty return scheduled() ? value : p; }); ``` ## Scheduling explanation This package provides 4 different methods for scheduling a callback. Pick one that suits your application. ``` TOP: scheduled function triggered BOTTOM: called user callback 1. debounce 2. throttle 3. leading debounce 4. leading throttle 5. leadingAndTrailing debounce 6. leadingAndTrailing throttle █ █ █ ------------------------> 1. █ 2. █ █ 3. █ 4. █ █ 5. █ █ 6. █ █ █ ``` [**Interactive DEMO of the schematic above**](https://primitives.solidjs.community/playground/scheduled) ## Changelog See [CHANGELOG.md](./CHANGELOG.md) --- _Source: https://npm.io/package/@solid-primitives/scheduled · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._