# @solid-primitives/trigger

> A set of primitives based on Solid signals, used to trigger computations.

Latest version **1.2.4** (published 2026-07-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @solid-primitives/trigger
pnpm add @solid-primitives/trigger
yarn add @solid-primitives/trigger
bun add @solid-primitives/trigger
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2026-07-04 |
| First published | 2022-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1559 |
| Author | Damian Tarnawski |
| Maintainers | davedbase, lexlohr, thetarnav. |
| Keywords | solid, primitives, signal, trigger |

## Links

- npm: https://www.npmjs.com/package/@solid-primitives/trigger
- Repository: https://github.com/solidjs-community/solid-primitives
- Homepage: https://primitives.solidjs.community/package/trigger
- Issues: https://github.com/solidjs-community/solid-primitives/issues
- npm.io page: https://npm.io/package/@solid-primitives/trigger

## Dependencies (1)

- [@solid-primitives/utils](https://npm.io/package/@solid-primitives/utils.md) ^6.4.1

## 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.2.4 (latest) — 2026-07-04
- 3.0.0-next.2 (next) — 2026-08-12
- 1.0.2-beta.0 (beta) — 2023-03-03
- 3.0.0-next.1 — 2026-07-18
- 3.0.0-next.0 — 2026-06-26
- 1.2.3 — 2026-02-24
- 1.2.2 — 2025-06-29
- 1.2.1 — 2025-04-27
- 1.2.0 — 2025-01-22
- 1.1.0 — 2024-09-29
- 1.0.11 — 2024-03-05
- 1.0.10 — 2024-02-28
- 1.0.9 — 2024-01-16
- 1.0.8 — 2023-08-04
- 1.0.7 — 2023-05-19
- … 10 more at https://npm.io/package/@solid-primitives/trigger/versions

## README

<p>
  <img width="100%" src="https://assets.solidjs.com/banner?type=Primitives&background=tiles&project=trigger" alt="Solid Primitives trigger">
</p>

# @solid-primitives/trigger

[![size](https://img.shields.io/bundlephobia/minzip/@solid-primitives/trigger?style=for-the-badge&label=size)](https://bundlephobia.com/package/@solid-primitives/trigger)
[![version](https://img.shields.io/npm/v/@solid-primitives/trigger?style=for-the-badge)](https://www.npmjs.com/package/@solid-primitives/trigger)
[![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-1.json)](https://github.com/solidjs-community/solid-primitives#contribution-process)

A set of primitives based on Solid signals, used to trigger computations.

- [`createTrigger`](#createtrigger) - Set listeners in reactive computations and then trigger them when you want.
- [`createTriggerCache`](#createtriggercache) - Creates a cache of triggers that can be used to mark dirty only specific keys.

## Installation

```bash
npm install @solid-primitives/trigger
# or
yarn add @solid-primitives/trigger
# or
pnpm add @solid-primitives/trigger
```

## `createTrigger`

Set listeners in reactive computations and then trigger them when you want.

### How to use it

```ts
import { createTrigger } from "@solid-primitives/trigger";

const [track, dirty] = createTrigger();

createEffect(() => {
  track();
  // ...
});

// later
dirty();
```

## `createTriggerCache`

Creates a cache of triggers that can be used to mark dirty only specific keys.

Cache is a `Map` or `WeakMap` depending on the `mapConstructor` argument. (default: `Map`)

If `mapConstructor` is `WeakMap` then the cache will be weak and the keys will be garbage collected when they are no longer referenced.

Trigger signals added to the cache only when tracked under a computation,
and get deleted from the cache when they are no longer tracked.

### How to use it

`track` and `dirty` are called with a `key` so that each tracker will trigger an update only when his individual `key` would get marked as dirty.

```ts
import { createTriggerCache } from "@solid-primitives/trigger";

const map = createTriggerCache<number>();

createEffect(() => {
  map.track(1);
  //  ...
});

// later
map.dirty(1);
// this won't cause an update:
map.dirty(2);
```

### Triggering all keys

`dirtyAll` will trigger all keys in the cache.

```ts
const [track, _dirty, dirtyAll] = createTriggerCache<number>();

createEffect(() => {
  track(1);
  //  ...
});

// later (will trigger the update)
dirtyAll();
```

### Weak version

`createTriggerCache` constructor can take a `WeakMap` constructor as an argument. This will create a `WeakMap` of triggers instead of a `Map`.

```ts
const map = createTriggerCache<object>(WeakMap);

const obj = {};

createEffect(() => {
  map.track(obj);
  //  ...
});

// later
map.dirty(obj);
```

## Demo

TODO

## Changelog

See [CHANGELOG.md](./CHANGELOG.md)

---
_Source: https://npm.io/package/@solid-primitives/trigger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
