functional-examplesFUNCTIONAL-EXAMPLES
API/@functional-examples/documentation/ExampleAccessor

ExampleAccessor

interface
interface ExampleAccessor

Scoped API returned by example(id) inside guide templates.

PROPERTIES

NAMETYPEDESCRIPTION
description?stringThe example's description.
filesExampleFile[]All files in the example.
metadataRecord<string, unknown>The example's metadata.
titlestringThe example's title.

METHODS

file(relativePath: string): FileAccessor

Return a chainable FileAccessor for a file.

region(regionId: string): string

Render a region/hunk as a fenced code block (throws if ambiguous).