Example
interfaceinterface Example<TMetadata>A discovered example with metadata and files.
This is the base type returned by extractors.
Metadata is typed via ExampleMetadata by default, which can be augmented
by running functional-examples generate. You can also pass an explicit
generic parameter for custom typing.
PROPERTIES
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| description? | string | Optional description |
| extractorName | string | Which extractor produced this example |
| files | ExampleFile[] | All files belonging to this example |
| id | string | Unique identifier for this example |
| metadata | TMetadata | Additional metadata (loosely typed unless user provides schema) |
| rootPath | string | Absolute path to the example root (file or directory) |
| title | string | Human-readable title |