Skip to content
Termwright

Interface: SerializeOptions

@termwright/test

@termwright/test / SerializeOptions

Interface: SerializeOptions

Section titled “Interface: SerializeOptions”

Defined in: test/src/yaml-serialize.ts:21

Options for serializeSemanticSnapshot.

Properties

Section titled “Properties”

includeRoot?

Section titled “includeRoot?”

readonly optional includeRoot?: boolean

Defined in: test/src/yaml-serialize.ts:39

With rootId, whether that node is itself the top level (default) or only the parent of it — false serializes what is inside the node, which is what scoping to a container is normally for.

indent?

Section titled “indent?”

readonly optional indent?: number

Defined in: test/src/yaml-serialize.ts:31

Indentation per level, in spaces. Default 4, matching the contract.

rootId?

Section titled “rootId?”

readonly optional rootId?: string

Defined in: test/src/yaml-serialize.ts:33

Serialize this node and its descendants instead of the whole tree.

skipHidden?

Section titled “skipHidden?”

readonly optional skipHidden?: boolean

Defined in: test/src/yaml-serialize.ts:41

Drop nodes carrying state.hidden. Default false.

states?

Section titled “states?”

readonly optional states?: StateSelection

Defined in: test/src/yaml-serialize.ts:29

State keys to emit.

stable (default) skips positional and scroll states, which change on every repaint and would make snapshots churn; all emits every key set by the adapter; an explicit list pins exactly what the test cares about.