ScannedExample
classclass ScannedExample<TMetadata>An example after processing by the scanner.
Includes computed fields like displayPath that are added during scanning.
PROPERTIES
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| readonly description? | string | Optional description |
| readonly displayPath | string | Path relative to the config/scan root, useful for display in errors and snapshots (avoids machine-specific absolute paths). |
| readonly extractorName | string | Which extractor produced this example |
| readonly files | ExampleFile[] | All files belonging to this example |
| readonly id | string | Unique identifier for this example |
| readonly metadata | TMetadata | Additional metadata (loosely typed unless user provides schema) |
| readonly rootPath | string | Absolute path to the example root (file or directory) |
| readonly title | string | Human-readable title |
METHODS
file(relativePath: string): ExampleFileFind a file by its path relative to the example root.