API Reference
Cinder.scan
Scan a document or parent node for semantic tags and produce normalized scan results.
Need the shortest path?
Use Quick Start when you want the smallest working route → scan → graph → run flow first.
Something feels off?
Inspect scan output, graph state, active route/context, and dispatch in a practical order.
Need the full surface?
Browse all runtime methods, hooks, extension points, and lifecycle APIs.
scan() is how the runtime discovers semantic structure in the DOM and refreshes the current graph snapshot.
Example
const scanResult = await Cinder.scan(document);
console.log(scanResult.entries, scanResult.warnings, scanResult.summary);Why it matters
The scan result is the bridge between tagged UI and graph construction.
Root parameter
You can pass a document or a parent node when you want to limit scanning to a smaller surface.
What to inspect
Check:
entrieswarningssummary- route/context assignment
- the refreshed
Cinder.graph()output right after scan
Practical timing note
If the page has not rendered its tagged surface yet, the scan result will be incomplete. In most integrations, scan after the real semantic UI is present.
If mutation observation is enabled, later DOM changes can also trigger rescans automatically.
Continue reading