renderer
Rendererβ
Constructorsβ
new Renderer()β
new Renderer(
printer,
outputDir,
baseURL,
group,
prettify,
docOptions): Renderer
Parametersβ
β’ printer: typeof IPrinter
β’ outputDir: string
β’ baseURL: string
β’ group: Maybe
<Partial
<Record
<SchemaEntity
, Record
<string
, Maybe
<string
>>>>>
β’ prettify: boolean
β’ docOptions: Maybe
<RendererDocOptions
>
Returnsβ
Defined inβ
renderer.ts:74
Propertiesβ
baseURLβ
baseURL: string;
Defined inβ
renderer.ts:68
groupβ
group: Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>;
Defined inβ
renderer.ts:66
optionsβ
options: Maybe<RendererDocOptions>;
Defined inβ
renderer.ts:70
outputDirβ
outputDir: string;
Defined inβ
renderer.ts:67
prettifyβ
prettify: boolean;
Defined inβ
renderer.ts:69
Methodsβ
generateCategoryMetafile()β
generateCategoryMetafile(
category,
dirPath,
sidebarPosition?,
styleClass?,
options?): Promise<void>
Parametersβ
β’ category: string
β’ dirPath: string
β’ sidebarPosition?: number
β’ styleClass?: string
β’ options? = ...
β’ options.collapsed?: boolean
β’ options.collapsible?: boolean
Returnsβ
Promise
<void
>
Defined inβ
renderer.ts:90
generateCategoryMetafileType()β
generateCategoryMetafileType(
type,
name,
rootTypeName): Promise<string>
Parametersβ
β’ type: unknown
β’ name: string
β’ rootTypeName: SchemaEntity
Returnsβ
Promise
<string
>
Defined inβ
renderer.ts:125
renderHomepage()β
renderHomepage(homepageLocation): Promise<void>
Parametersβ
β’ homepageLocation: string
Returnsβ
Promise
<void
>
Defined inβ
renderer.ts:270
renderRootTypes()β
renderRootTypes(rootTypeName, type): Promise<Maybe<Maybe<Category>[]>>
Parametersβ
β’ rootTypeName: SchemaEntity
β’ type: unknown
Returnsβ
Promise
<Maybe
<Maybe
<Category
>[]>>
Defined inβ
renderer.ts:180
renderTypeEntities()β
renderTypeEntities(
dirPath,
name,
type): Promise<Maybe<Category>>
Parametersβ
β’ dirPath: string
β’ name: string
β’ type: unknown
Returnsβ
Promise
<Maybe
<Category
>>
Defined inβ
renderer.ts:214
API_GROUPSβ
const API_GROUPS: Required<ApiGroupOverrideType>;
Defined inβ
renderer.ts:42
getApiGroupFolder()β
function getApiGroupFolder(type, groups?): string
Parametersβ
β’ type: unknown
β’ groups?: Maybe
<boolean
| ApiGroupOverrideType
>
Returnsβ
string
Defined inβ
renderer.ts:47
getRenderer()β
function getRenderer(
printer,
outputDir,
baseURL,
group,
prettify,
docOptions): Promise<Renderer>
Parametersβ
β’ printer: typeof IPrinter
β’ outputDir: string
β’ baseURL: string
β’ group: Maybe
<Partial
<Record
<SchemaEntity
, Record
<string
, Maybe
<string
>>>>>
β’ prettify: boolean
β’ docOptions: Maybe
<RendererDocOptions
>
Returnsβ
Promise
<Renderer
>
Defined inβ
renderer.ts:288