functional-examplesFUNCTIONAL-EXAMPLES
API/@functional-examples/yaml-manifest/createMetaYmlExtractor

createMetaYmlExtractor

function
function createMetaYmlExtractor(opts?: MetaYmlExtractorOptions): Extractor;

Create a meta.yml extractor.

Scans for directories containing meta.yml files. Each such directory
is treated as a multi-file example with all its contents.

PARAMETERS

NAMETYPEDESCRIPTION
opts?MetaYmlExtractorOptions—

RETURNS

Extractor

EXAMPLES

import { createMetaYmlExtractor } from '@functional-examples/yaml-manifest';

const extractor = createMetaYmlExtractor({
  metaFileName: 'meta.yaml', // use different filename
});

// Use with scanExamples
import { scanExamples } from 'functional-examples';

const result = await scanExamples({
  root: './examples',
  extractors: [extractor],
});