API reference › @evolu/common › Task › AbortMask

type AbortMask = number &
  import("/vercel/path0/packages/common/src/Brand").Brand<"Int"> &
  import("/vercel/path0/packages/common/src/Brand").Brand<"NonNegative"> &
  import("/vercel/path0/packages/common/src/Brand").Brand<"AbortMask">;

Defined in: packages/common/src/Task.ts:945

Abort mask depth for a Run or Fiber.

  • 0 — abortable (default)
  • >= 1 — inside unabortable, abort requests are ignored

The mask tracks nested unabortable regions. When abort is requested, the signal only propagates if mask === 0.

  • unabortable increments the mask — Task becomes protected
  • unabortableMask provides restore to restore the previous mask
  • Tasks inherit their parent's mask by default

This enables nested resource lifecycle patterns where each level can have its own abortable section while outer acquisitions remain protected.

UI/debugging tools can use this to visually distinguish protected Tasks (e.g., different icon or color) and explain why abort requests are ignored.

Markdown for LLMs