v0.4.4

Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / ts-docs / generator / Generator

Class Generator

Defined in index.ts

The class responsible for creating the documentation. Takes in a documentation structure and settings.

Constructor

constructor(
settings: TsDocsOptionsinterface TsDocsOptionsts-docs/TsDocsOptions,
fileHost = FileHostinterface FileHostts-docs/fileHost/FileHost,
activeBranch = "main"
)

Properties

structure: DocumentStructuretype DocumentStructurets-docs/documentStructure/DocumentStructure[src]
settings: TsDocsOptionsinterface TsDocsOptionsts-docs/TsDocsOptions[src]
depth = 0[src]

How "deep" the current thing is from the root.

currentGlobalModuleName?: string[src]

The name of the current global Moduleinterface Moduleextractor/extractor/Module being rendered. It's going to be undefined if there is only one entry point.

renderingPages?: boolean[src]

Only true when the custom pages are being rendered

landingPage: LandingPageinterface LandingPagets-docs/LandingPage[src]
projects: Arrayexternal Array<Projectclass Projectextractor/extractor/Project>[src]
extractor: TypescriptExtractorclass TypescriptExtractorextractor/extractor/TypescriptExtractor[src]
currentModule: Moduleinterface Moduleextractor/extractor/Module[src]
currentProject: Projectclass Projectextractor/extractor/Project[src]
currentItem: Declarationtype Declarationextractor/extractor/Declaration[src]
tests?: TestCollectorclass TestCollectorts-docs/tests/TestCollector[src]
categories: Recordexternal Record<string, Arrayexternal Array<Referenceinterface Referenceextractor/extractor/Reference>>[src]
fileHost: FileHostinterface FileHostts-docs/fileHost/FileHost[src]

Methods

generate(
extractor: TypescriptExtractorclass TypescriptExtractorextractor/extractor/TypescriptExtractor,
projects?: Arrayexternal Array<Projectclass Projectextractor/extractor/Project>
): Promiseexternal Promise<void>[src]
generateLanding(project: Projectclass Projectextractor/extractor/Project): void[src]

Generates a landing page with data taken from a project.

This method changes the depthproperty Generator.depthts-docs/generator/Generator to 0!

generateChangelog(
repo: string,
projects?: Arrayexternal Array<Projectclass Projectextractor/extractor/Project>,
module?: Moduleinterface Moduleextractor/extractor/Module
): Promiseexternal Promise<void>[src]
generateThingsInsideModule(path: string, module: Moduleinterface Moduleextractor/extractor/Module): void[src]
generateModule(p: string, module: Moduleinterface Moduleextractor/extractor/Module, readme?: string): void[src]
generateModuleIndex(p: string, module: Moduleinterface Moduleextractor/extractor/Module, readme?: string): void[src]
generateClass(path: string, classObj: ClassDeclinterface ClassDeclextractor/extractor/ClassDecl): void[src]
generateInterface(
path: string,
interfaceObj: InterfaceDeclinterface InterfaceDeclextractor/extractor/InterfaceDecl
): void[src]
generateEnum(path: string, enumObj: EnumDeclinterface EnumDeclextractor/extractor/EnumDecl): void[src]
generateTypeDecl(path: string, typeObj: TypeDeclinterface TypeDeclextractor/extractor/TypeDecl): void[src]
generateFunction(path: string, func: FunctionDeclinterface FunctionDeclextractor/extractor/FunctionDecl): void[src]
generateConstant(path: string, constant: ConstantDeclinterface ConstantDeclextractor/extractor/ConstantDecl): void[src]
generateConstructType(
ref: FunctionSignatureinterface FunctionSignatureextractor/extractor/FunctionSignature | ConstructorTypetype ConstructorTypeextractor/extractor/ConstructorType,
includeNew?: boolean
): string[src]
generateRef(
ref: Referenceinterface Referenceextractor/extractor/Reference,
other: OtherRefDatainterface OtherRefDatats-docs/generator/OtherRefData = {},
raw?: boolean
): string[src]
generateArrowFunction(ref: ArrowFunctioninterface ArrowFunctionextractor/extractor/ArrowFunction): string[src]
generateType(
type: Typetype Typeextractor/extractor/Type,
other: Recordexternal Record<string, unknown> = {}
): string[src]
generateTypeParameter(type: TypeParameterinterface TypeParameterextractor/extractor/TypeParameter): string[src]
generateParameter(type: FunctionParameterinterface FunctionParameterextractor/extractor/FunctionParameter): string[src]
generateComment(
comments?: Arrayexternal Array<JSDocDatainterface JSDocDataextractor/extractor/JSDocData>,
includeTags = false,
exclude?: Recordexternal Record<string, boolean>,
fnName?: string
): [block: string, inline: string] | undefined[src]
generateInlineComment(comments?: Arrayexternal Array<JSDocDatainterface JSDocDataextractor/extractor/JSDocData>): string | undefined[src]
generateMarkdownWithHeaders(content: string): [string, Arrayexternal Array<Headinginterface Headingts-docs/generator/Heading>][src]
generateExports(module: Moduleinterface Moduleextractor/extractor/Module): ModuleExportstype ModuleExportsts-docs/generator/ModuleExports[src]
generatePage(
p: string,
directory: string,
file: string,
content: string,
other: Partialexternal Partial<IndexDatainterface IndexDatats-docs/generator/IndexData & OtherPropsinterface OtherPropsts-docs/generator/OtherProps> = {}
): string[src]
sortArr(arr: Arrayexternal Array<any>, name: "rawName" | "name"): void[src]
addItemToCategory(decl: Declarationtype Declarationextractor/extractor/Declaration): void[src]