frozenOfconstconst frozenOf: (s: Step) => FrozenStepThe step of a plan as it is frozen.
The file of a step (commons data 0018-sql-history FR-001): SQL a person can read, with a header and markers that a program reads back. The same step gives the same text every time and the text gives the step back.
frozenOfconstconst frozenOf: (s: Step) => FrozenStepThe step of a plan as it is frozen.
FrozenStepinterfaceno test imports itinterface FrozenStepA step as a file holds it: what a run needs, and what a person needs to read.
| Member | Type | What it is |
|---|---|---|
id | string | |
name | string | |
from | string | |
to | string | |
key | string | |
kind | string | |
class | string | |
why? | string | |
reversibility | string | |
idempotency? | string | |
manual | boolean | |
of | readonly string[] | |
up | readonly StepStatement[] | |
down? | readonly StepStatement[] | |
verify? | Verification |
parseStepfunctionfunction parseStep(text: string): Result<{ readonly number: number; readonly step: FrozenStep; }, readonly string[]>The step a file holds.
| Parameter | What it is |
|---|---|
text | the text of the file |
Returns: the step and its number, or what is wrong with the file
pathOfconstconst pathOf: (folder: string, number: number, name: string) => stringThe path of a step's file in a folder.
renderStepfunctionfunction renderStep(s: FrozenStep, number: number): stringA step as the text of its file.
| Parameter | What it is |
|---|---|
s | the step |
number | its place in the history, from 1 |
Returns: the text
slugconstconst slug: (name: string) => stringA name as a file name: lower case words and hyphens.