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

ConsumptionTracker

class
class ConsumptionTracker

Tracks which example files have been "consumed" by prose template helpers
(e.g. file() or region()). Consumed files are excluded from the
"remaining files" section in the rendered output.

METHODS

consume(relativePath: string): void

Mark a file as consumed by its relative path.

getUnconsumedFiles(files: ExampleFile[]): ExampleFile[]

Return only those files that have NOT been consumed.

isConsumed(relativePath: string): boolean

Check whether a file has been consumed.