Typescoop
BuildOptions
The configuration options for the typescoop config file.
Type
| 'only-public'
| 'all'
Description
Controls which exported entities are documented.
Type
string[]
Description
Files or directories whose exports are documented. Defaults to the files
included by the tsconfig.
Type
(
opts: ImportResolverParams,
) =>
| Promise<
string | undefined
>
| string
| undefined
Description
Used to generate type info popups for resolved symbols.
Type
{
maxLength?: number
maxMembers?: number
}
Description
Limits for printing small documented object types, such as
{end: DateValue; start: DateValue}, inline in place of their name.Type
| 'info'
| 'quiet'
Description
The log level for runtime logs.
Type
string[]
Description
Include all entities from these modules regardless of documentationScope. This field does nothing when documentationScope is
set to
all, as every module considered public in that case.["@qualcomm-ui/react", "@qualcomm-ui/react-core"]
Type
stringDescription
The relative file path for the resolved interfaces. The output contains
formatted API data featuring expanded pretty types, links to named types,
and more.
Type
booleanDescription
Whether to prettify the output JSON to make it human-readable.
Type
Record<
string,
string
>
Description
Map of type names to their corresponding page pathname on the docs site.
Type
stringDescription
The tsconfig that defines the compiler options and, unless
entryPoints is set, the files to document.
Updated by Ryan Bower