Skip to content

Docs/callback lifecycle semantics#61

Merged
saraeloop merged 3 commits intomainfrom
docs/callback-lifecycle-semantics
May 6, 2026
Merged

Docs/callback lifecycle semantics#61
saraeloop merged 3 commits intomainfrom
docs/callback-lifecycle-semantics

Conversation

@saraeloop
Copy link
Copy Markdown
Member

Follow-up README cleanup

  • Removed a duplicate ## Considerations heading.
  • Clarified disposed-surface wording:
Destroying a runtime disposes its registered surfaces. Disposed surfaces report `isDisposed === true`; `getBounds()` and `setBounds()` throw.

saraeloop added 2 commits May 6, 2026 11:53
Document Prism's current runtime contract more explicitly.

What changed:

- Clarify that onPaint() and onUpdate() are additive callbacks.

- Document manual vs automatic invalidation.

- Document repeated registerSurface() behavior for the same element/runtime.

- Document wrong-runtime surface behavior.

- Clarify that runtime.destroy() disposes registered surfaces.

- Document disposed surface behavior.

- Clarify paintOnce() behavior without start(), concurrent waiters,

  inside-paint calls, and pending waiter rejection.

- Document that Prism does not expose a general event system or unsubscribe API today.

Verification:

- pnpm --filter @prism/docs build

- pnpm lint

- pnpm typecheck

- pnpm test
Fix README cleanup from the runtime semantics docs pass.

What changed:

- Remove duplicate Considerations heading.

- Clarify disposed-surface behavior:

  destroyed runtimes dispose registered surfaces, disposed surfaces report

  isDisposed === true, and getBounds()/setBounds() throw.

No runtime behavior changes.
@saraeloop saraeloop self-assigned this May 6, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
prism-docs Ready Ready Preview, Comment May 6, 2026 6:57pm

@saraeloop saraeloop merged commit 4358074 into main May 6, 2026
10 checks passed
@saraeloop saraeloop deleted the docs/callback-lifecycle-semantics branch May 6, 2026 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant