OkfIndexDocument class final

The parsed content of an OKF index.md document.

This type owns the index.md entry format: producers emit through serialize and consumers read through parse, so no other module needs to know how an entry is spelled.

Constructors

OkfIndexDocument({required Iterable<OkfIndexEntry> entries, String? okfVersion})
Creates an index document from entry data.

Properties

entries → List<OkfIndexEntry>
The entries in document order.
final
hashCode → int
The hash code for this object.
no setterinherited
okfVersion → String?
The declared OKF version, or null when the document declares none.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
serialize() → String
Emits the document.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

parse(String source, {String? sourcePath}) → OkfIndexParseResult
Parses a complete index file, frontmatter included.
parseBody(String body) → OkfIndexParseResult
Parses an index body already separated from its frontmatter.