@plures/praxis

---

@plures/praxis / index / StateDoc

Interface: StateDoc

Defined in: src/integrations/state-docs.ts:91

State documentation

Properties

description?

optional description?: string

Defined in: src/integrations/state-docs.ts:97

State description

---

final?

optional final?: boolean

Defined in: src/integrations/state-docs.ts:101

Is this a final state

---

id

id: string

Defined in: src/integrations/state-docs.ts:93

State identifier

---

initial?

optional initial?: boolean

Defined in: src/integrations/state-docs.ts:99

Is this an initial state

---

name

name: string

Defined in: src/integrations/state-docs.ts:95

State name

---

onEntry?

optional onEntry?: string[]

Defined in: src/integrations/state-docs.ts:103

Entry actions

---

onExit?

optional onExit?: string[]

Defined in: src/integrations/state-docs.ts:105

Exit actions

---

tags?

optional tags?: string[]

Defined in: src/integrations/state-docs.ts:107

State tags