ModuleExtractorclass
new ModuleExtractor()
| Return | |
|---|---|
ModuleExtractor | Extractor that builds a kind: "module" DocumentationElement from a source file or directory. |
Extractor that builds a kind: "module" DocumentationElement from a source file or directory.
- The module's
content,description, andtitleare taken from the source element (MergingExtractorandIndexExtractorare expected to have run upstream so.mdsiblings andREADME.mdare already folded in). - The module's
childrenare everytree-documentationelement found by deep-walking the source — flattened across
files and subdirectories, but never descending into atree-documentation's own members.
Examples
const module = new ModuleExtractor().extract({ name: "util/string", source });