IF Commons GitHub

sql/extensions/history/format

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0018-sql-history FR-001

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.

Source: commons/data/sql/extensions/history/format.ts

5 of 6 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

frozenOfconst
const frozenOf: (s: Step) => FrozenStep

The step of a plan as it is frozen.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

FrozenStepinterfaceno test imports it
interface FrozenStep

A step as a file holds it: what a run needs, and what a person needs to read.

MemberTypeWhat it is
idstring
namestring
fromstring
tostring
keystring
kindstring
classstring
why?string
reversibilitystring
idempotency?string
manualboolean
ofreadonly string[]
upreadonly StepStatement[]
down?readonly StepStatement[]
verify?Verification
parseStepfunction
function parseStep(text: string): Result<{ readonly number: number; readonly step: FrozenStep; }, readonly string[]>

The step a file holds.

ParameterWhat it is
textthe text of the file

Returns: the step and its number, or what is wrong with the file

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

pathOfconst
const pathOf: (folder: string, number: number, name: string) => string

The path of a step's file in a folder.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

renderStepfunction
function renderStep(s: FrozenStep, number: number): string

A step as the text of its file.

ParameterWhat it is
sthe step
numberits place in the history, from 1

Returns: the text

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

slugconst
const slug: (name: string) => string

A name as a file name: lower case words and hyphens.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.