Skip to main content

renderer

Renderer

Defined in: packages/core/src/renderer.ts:65

Constructors

new Renderer()

new Renderer(
printer,
outputDir,
baseURL,
group,
prettify,
docOptions): Renderer

Defined in: packages/core/src/renderer.ts:74

Parameters
printer

typeof IPrinter

outputDir

string

baseURL

string

group

Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>

prettify

boolean

docOptions

Maybe<RendererDocOptions>

Returns

Renderer

Properties

baseURL

baseURL: string;

Defined in: packages/core/src/renderer.ts:68

group

group: Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>;

Defined in: packages/core/src/renderer.ts:66

options

options: Maybe<RendererDocOptions>;

Defined in: packages/core/src/renderer.ts:70

outputDir

outputDir: string;

Defined in: packages/core/src/renderer.ts:67

prettify

prettify: boolean;

Defined in: packages/core/src/renderer.ts:69

Methods

generateCategoryMetafile()

generateCategoryMetafile(
category,
dirPath,
sidebarPosition?,
styleClass?,
options?): Promise<void>

Defined in: packages/core/src/renderer.ts:90

Parameters
category

string

dirPath

string

sidebarPosition?

number

styleClass?

string

options?
collapsed

boolean

collapsible

boolean

Returns

Promise<void>

generateCategoryMetafileType()

generateCategoryMetafileType(
type,
name,
rootTypeName): Promise<string>

Defined in: packages/core/src/renderer.ts:125

Parameters
type

unknown

name

string

rootTypeName

SchemaEntity

Returns

Promise<string>

renderHomepage()

renderHomepage(homepageLocation): Promise<void>

Defined in: packages/core/src/renderer.ts:270

Parameters
homepageLocation

string

Returns

Promise<void>

renderRootTypes()

renderRootTypes(rootTypeName, type): Promise<Maybe<Maybe<Category>[]>>

Defined in: packages/core/src/renderer.ts:180

Parameters
rootTypeName

SchemaEntity

type

unknown

Returns

Promise<Maybe<Maybe<Category>[]>>

renderTypeEntities()

renderTypeEntities(
dirPath,
name,
type): Promise<Maybe<Category>>

Defined in: packages/core/src/renderer.ts:214

Parameters
dirPath

string

name

string

type

unknown

Returns

Promise<Maybe<Category>>


API_GROUPS

const API_GROUPS: Required<ApiGroupOverrideType>;

Defined in: packages/core/src/renderer.ts:42


getApiGroupFolder()

function getApiGroupFolder(type, groups?): string

Defined in: packages/core/src/renderer.ts:47

Parameters

type

unknown

groups?

Maybe<boolean | ApiGroupOverrideType>

Returns

string


getRenderer()

function getRenderer(
printer,
outputDir,
baseURL,
group,
prettify,
docOptions): Promise<Renderer>

Defined in: packages/core/src/renderer.ts:288

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>