expectDocument

function expectDocument(
   engine,
   text,
   options?
): Promise<DocumentAssertion>;

Defined in: packages/engine/src/testing/index.ts:579

Evaluate text as a whole document on engine, wait for any live values it starts to settle, and return per-line matchers.

The document goes through the incremental pass a live editor uses (evaluateDocument), so every whole-document form resolves: line references, category tags, table columns and goal seek. While any line is Pending, the kit awaits ExpressionEngine.settle and evaluates the document again, until none is or the deadline passes. A line still Pending at the deadline is left Pending, for ExpressionAssertion.toBePending to confirm or another matcher to report.

Parameters

Parameter	Type
engine	ExpressionEngine
text	string
options	SettleOptions

Returns

Promise<DocumentAssertion>

Example

const doc = await expectDocument(engine, ":rate = 4%\n1000 * rate");
doc.line(2).toEqual(40);