@solid-primitives/trigger

@solid-primitives/trigger

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

• createTrigger - Set listeners in reactive computations and then trigger them when you want.
• createTriggerCache - A map of triggers cached by a key.
• createWeakTriggerCache - A weakmap of triggers cached by a weak key.

Installation

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

createTrigger

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

How to use it

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

const [track, dirty] = createTrigger();

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

// later
dirty();

createTriggerCache

A map of triggers cached by a key.

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.

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

const { track, dirty } = createTriggerCache();

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

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

createWeakTriggerCache

A weakmap of triggers cached by a weak key.

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.

import { createWeakTriggerCache } from "@solid-primitives/trigger";

const { track, dirty } = createWeakTriggerCache();
const key = {};

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

// later
dirty(key);
// this won't cause an update:
dirty({});

Demo

TODO

Changelog

See CHANGELOG.md