StringTune/Docs

API Reference

StringData

Top-level runtime state container shared across modules, tools, and controllers.

StringData

StringData is the main shared state container exported by the package.

Public status

StringData is exported by the package root and is valid advanced integration surface.

What it contains

It aggregates:

  • scroll
  • viewport
  • cursor
  • render
  • time
  • system

Why it matters

This is the object passed through the runtime into:

  • module lifecycle hooks
  • controllers
  • context-aware utilities

If you need live runtime state in a custom module, this is the correct top-level entry point.

Practical note

The nested state classes are documented separately, but the usual public authoring surface is still StringData as a whole.