Interfaces

SemanticDeclaration

Interface: SemanticDeclaration

Defined in: src/lib/semantics/types.ts:175

What a tool author passes to semantic(). At least one of series, facts, edges or a non-null clarify must be present — an envelope with no data and no question declares nothing.

not_covered is deliberately NOT here: the prose list on the rendered envelope is DERIVED from coverage (not checked + cannot cover), so the two can never disagree. Declaring coverage is how not_covered is said.

Properties

clarify?

readonly optional clarify?: SemanticClarify | null

Defined in: src/lib/semantics/types.ts:185

null states "ambiguity was considered; there is none" — a fact, kept on the record. Omit the field to say nothing.


coverage?

readonly optional coverage?: CoverageDeclaration

Defined in: src/lib/semantics/types.ts:182

The coverage()-vocabulary declaration this envelope absorbs.


edges?

readonly optional edges?: readonly SemanticEdge[]

Defined in: src/lib/semantics/types.ts:178


facts?

readonly optional facts?: readonly SemanticFact[]

Defined in: src/lib/semantics/types.ts:177


grain?

readonly optional grain?: SemanticGrain

Defined in: src/lib/semantics/types.ts:179


provenance?

readonly optional provenance?: SemanticProvenance

Defined in: src/lib/semantics/types.ts:180


render?

readonly optional render?: SemanticRender

Defined in: src/lib/semantics/types.ts:186


series?

readonly optional series?: readonly SemanticSeriesPoint[]

Defined in: src/lib/semantics/types.ts:176

On this page