Typescoop

BuildOptions

The configuration options for the typescoop config file.

PropTypeDefault
Controls which exported entities are documented.
  • all: every exported type will be processed. This will increase the size of the JSON model.
  • only-public: entities must be marked with an @public JSDoc tag to be processed into type documentation.
| 'only-public'
| 'all'
'all'
Files or directories whose exports are documented. Defaults to the files included by the tsconfig.
string[]
Used to generate type info popups for resolved symbols.
(
opts: ImportResolverParams,
) =>
| Promise<
string | undefined
>
| string
| undefined
Limits for printing small documented object types, such as {end: DateValue; start: DateValue}, inline in place of their name.
{
maxLength?: number
maxMembers?: number
}
The log level for runtime logs.
| 'info'
| 'quiet'
'info'
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.
string[]
The relative file path for the resolved interfaces. The output contains formatted API data featuring expanded pretty types, links to named types, and more.
string
".typescoop/type-data.json"
Whether to prettify the output JSON to make it human-readable.
boolean
Map of type names to their corresponding page pathname on the docs site.
Record<
string,
string
>
The tsconfig that defines the compiler options and, unless entryPoints is set, the files to document.
string
Type
| 'only-public'
| 'all'
Description
Controls which exported entities are documented.
  • all: every exported type will be processed. This will increase the size of the JSON model.
  • only-public: entities must be marked with an @public JSDoc tag to be processed into type documentation.
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.
Type
string
Description
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
boolean
Description
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
string
Description
The tsconfig that defines the compiler options and, unless entryPoints is set, the files to document.
Updated by Ryan Bower
On this page