Interface: FormEngine

Defined in: packages/core/src/engine/engine.ts:99

Properties

definition

readonly definition: FormDefinition;

Defined in: packages/core/src/engine/engine.ts:100

---

diagnostics

readonly diagnostics: Diagnostic[];

Defined in: packages/core/src/engine/engine.ts:102

---

submissionId

readonly submissionId: string;

Defined in: packages/core/src/engine/engine.ts:101

Methods

addRepeat()

addRepeat(
   path, 
   at?, 
   initial?
): void;

Defined in: packages/core/src/engine/engine.ts:109

Parameters

Parameter	Type
path	string
at?	number
initial?	Record<string, unknown>

Returns

void

---

dispose()

dispose(): void;

Defined in: packages/core/src/engine/engine.ts:126

Returns

void

---

finalize()

finalize(): Result<Submission, ValidationResult>;

Defined in: packages/core/src/engine/engine.ts:114

Returns

Result<Submission, ValidationResult>

---

flushSync()

flushSync(): void;

Defined in: packages/core/src/engine/engine.ts:117

Returns

void

---

getState()

getState(): EngineState;

Defined in: packages/core/src/engine/engine.ts:103

Returns

EngineState

---

invalidateDataset()

invalidateDataset(name, index?): void;

Defined in: packages/core/src/engine/engine.ts:118

Parameters

Parameter	Type
name	string
index?	DatasetIndex

Returns

void

---

moveRepeat()

moveRepeat(
   path, 
   from, 
   to
): void;

Defined in: packages/core/src/engine/engine.ts:111

Parameters

Parameter	Type
path	string
from	number
to	number

Returns

void

---

on()

on<E>(event, handler): () => void;

Defined in: packages/core/src/engine/engine.ts:125

Type Parameters

Type Parameter
E extends keyof EngineEvents

Parameters

Parameter	Type
event	E
handler	(e) => void

Returns

() => void

---

recompute()

recompute(opts?): void;

Defined in: packages/core/src/engine/engine.ts:116

Parameters

Parameter	Type
opts?	{ volatile?: boolean; }
opts.volatile?	boolean

Returns

void

---

removeRepeat()

removeRepeat(path, index): void;

Defined in: packages/core/src/engine/engine.ts:110

Parameters

Parameter	Type
path	string
index	number

Returns

void

---

select()

select<T>(selector, equals?): object;

Defined in: packages/core/src/engine/engine.ts:121

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
selector	(s) => T
equals?	(a, b) => boolean

Returns

object

get()

get(): T;

Returns

T

subscribe()

subscribe(cb): () => void;

Parameters

Parameter	Type
cb	() => void

Returns

() => void

---

setLocale()

setLocale(locale): void;

Defined in: packages/core/src/engine/engine.ts:112

Parameters

Parameter	Type
locale	string

Returns

void

---

setValue()

setValue(
   path, 
   value, 
   opts?
): void;

Defined in: packages/core/src/engine/engine.ts:104

Parameters

Parameter	Type
path	string
value	unknown
opts?	{ source?: "migrate" | "user" | "calc" | `trigger:${string}`; }
opts.source?	"migrate" | "user" | "calc" | `trigger:${string}`

Returns

void

---

subscribe()

subscribe(listener): () => void;

Defined in: packages/core/src/engine/engine.ts:119

Parameters

Parameter	Type
listener	(patch) => void

Returns

() => void

---

subscribeField()

subscribeField(path, listener): () => void;

Defined in: packages/core/src/engine/engine.ts:120

Parameters

Parameter	Type
path	string
listener	(f) => void

Returns

() => void

---

toSubmission()

toSubmission(): Submission;

Defined in: packages/core/src/engine/engine.ts:115

Returns

Submission

---

validate()

validate(scope?): ValidationResult;

Defined in: packages/core/src/engine/engine.ts:113

Parameters

Parameter	Type
scope?	{ page?: string; path?: string; }
scope.page?	string
scope.path?	string

Returns

ValidationResult