OkfIndexGenerator class final

Generates deterministic, progressively disclosed index.md files.

For the same bundle and synthesizeDescription, the output bytes stay the same across every release sharing one okfIndexGeneratorRevision. A change to them ships only in a minor release, which sets that revision to its own version.

Constructors

OkfIndexGenerator({OkfDirectoryDescriptionSynthesizer? synthesizeDescription})

Creates an index generator.

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

synthesizeDescription → OkfDirectoryDescriptionSynthesizer?

Optional directory-summary callback.

final

Methods

generate(OkfBundle bundle, {String? declareVersion}) → Map<String, String>

Generates indexes, keyed by their bundle-relative path.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited