API/@functional-examples/devkit/Extractor

Extractor

interface

interface Extractor<TMetadata>

Candidate-based extractor interface.
Called with pre-filtered candidates (files and/or directories).
Extractor decides which candidates it can handle.

PROPERTIES

NAME	TYPE	DESCRIPTION
readonly name	`string`	Unique name for this extractor

METHODS

extract(candidates: Dirent<string>[], options: ExtractorOptions): Promise<ExtractorResult<TMetadata>>

Extract examples from the provided candidates. Candidates are pre-filtered by include/exclude patterns.