TypeDocNextra
new TypeDocNextra(options)
Parameter | Type | Optional | Description |
---|---|---|---|
options | TypeDocNextraMdBuilderOptions | ❌ | - |
Properties
public linker: (t: string, s: string) => string
public options: TypeDocNextraMdBuilderOptions
Methods
public getClassHeading(c): string
Parameter | Type | Optional | Description |
---|---|---|---|
c | DocumentedClass | ❌ | - |
public getCtor(c): string
Parameter | Type | Optional | Description |
---|---|---|---|
c | DocumentedClassConstructor | ❌ | - |
public getMarkdown(c): string
Parameter | Type | Optional | Description |
---|---|---|---|
c | DocumentedClass | ❌ | - |
public getMethods(methods): string
Parameter | Type | Optional | Description |
---|---|---|---|
methods | Array<DocumentedClassMethod> | ❌ | - |
public getProperties(properties): string
Parameter | Type | Optional | Description |
---|---|---|---|
properties | Array<DocumentedClassProperty> | ❌ | - |
public getTypeMarkdown(t): string
Parameter | Type | Optional | Description |
---|---|---|---|
t | DocumentedTypes | ❌ | - |
public transformClass(classes): Array<TypeDocNextraMarkdownBuild>
Parameter | Type | Optional | Description |
---|---|---|---|
classes | Array<DocumentedClass> | ❌ | - |
public transformTypes(types): Array<TypeDocNextraMarkdownBuild>
Parameter | Type | Optional | Description |
---|---|---|---|
types | Array<DocumentedTypes> | ❌ | - |