Toolmark

Appearance

toolmark-monorepo / @toolmark/core / ToolState

Interface: ToolState<I> ​

Defined in: packages/core/src/tool.ts:60

Side-effect-free snapshot of a tool's current state (spec §13), read through tm.state.

Redaction is owned by the tool that produces the state: values must already have every sensitive path (see ToolDefinition.sensitivePaths) replaced by '[redacted]', and must never contain fields the tool does not expose at all (e.g. excluded DOM controls). Form and wizard tools do this for their own state; a custom state() is responsible for its own values.

Type Parameters ​

I ​

I

Properties ​

issues ​

issues: object[]

Defined in: packages/core/src/tool.ts:64

Current validation issues.

message ​

message: string

path ​

path: string

step? ​

optional step?: string

Defined in: packages/core/src/tool.ts:66

Current wizard step, if any.

values ​

values: Partial<I>

Defined in: packages/core/src/tool.ts:62

Current values.