lib/docs - jsdoc-scribe API

Functions(2)

#extractModules

async

Extract documentation models from an array of file paths. All files are attempted; failures are logged to stderr and omitted from results. Uses Promise.allSettled so a single bad file never aborts the batch.

Parameter	Type	Optional	Description
`files`	`string[]`

Returns: Promise<object[]>

Signature

async extractModules(files: any): any

#generateSite

line 38

async

One-shot convenience: collect files, extract docs, build HTML site.

Parameter	Type	Optional	Description
`inputPaths`	`string\|string[]`		Source file or directory paths
`options`	`object`	yes	Same options as buildSite()

Returns: Promise<Array<{path:string,html:string}>>

Signature

async generateSite(inputPaths: any, options: any): any

Variables & Constants(11)

#{ collectFiles, DEFAULT_EXTENSIONS, DEFAULT_IGNORE_DIRS }

line 3

const { collectFiles, DEFAULT_EXTENSIONS, DEFAULT_IGNORE_DIRS }: any

const

Signature

const { collectFiles, DEFAULT_EXTENSIONS, DEFAULT_IGNORE_DIRS }: any

#{ extractModule }

line 4

const { extractModule }: any

const

Signature

const { extractModule }: any

#{ buildSite, moduleLabel, moduleHtmlPath }

line 5

const { buildSite, moduleLabel, moduleHtmlPath }: any

const

Signature

const { buildSite, moduleLabel, moduleHtmlPath }: any

#results

line 16

const results: any

const

Signature

const results: any

#modules

line 19

const modules: Array

const

Signature

const modules: Array

line 21

const r: any

const

Signature

const r: any

#paths

line 39

const paths: any

const

Signature

const paths: any

#opts

line 40

const opts: any

const

Signature

const opts: any

#files

line 41

const files: any

const

Signature

const files: any

#unique

line 42

const unique: Array

const

Signature

const unique: Array

#modules

line 43

const modules: any

const

Signature

const modules: any