`session`

Filters signals to only emit during active sessions. A session begins when the start predicate returns true and ends when the end predicate returns true.

Functions

session

Generic session operator with custom start/end predicates.

function session<T extends Signal>(options: {
  start: (signal: T) => boolean;
  end: (signal: T) => boolean;
}): Operator<T, T>

singlePointerSession

Pre-configured for SinglePointer signals (start → end/cancel).

function singlePointerSession(): Operator<SinglePointerSignal, SinglePointerSignal>

multiPointersSession

Pre-configured for MultiPointers signals with required pointer count.

function multiPointersSession(requiredCount: number): Operator<MultiPointersSignal, MultiPointersSignal>

Examples

Single Pointer Session

import { singlePointer } from "cereb";
import { singlePointerSession } from "cereb/operators";

singlePointer(element)
  .pipe(singlePointerSession())
  .on((signal) => {
    // Only receives signals from start to end/cancel
  });

Multi Pointers Session

import { multiPointers } from "cereb";
import { multiPointersSession } from "cereb/operators";

multiPointers(element, { maxPointers: 2 })
  .pipe(multiPointersSession(2)) // Wait for 2 pointers
  .on((signal) => {
    // Only when 2 pointers are active
  });

Custom Session

import { keyboard } from "cereb";
import { session } from "cereb/operators";

// Session from Space down to Space up
keyboard(window, { code: "Space" })
  .pipe(
    session({
      start: (s) => s.value.phase === "down",
      end: (s) => s.value.phase === "up"
    })
  )
  .on(handleSpaceHeld);

Session Lifecycle

[idle] → start predicate true → [active] → end predicate true → [idle] → ...

Both start and end signals are included in output
Sessions can repeat after ending