Skip to main content

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​

Renderer

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