Class WikiInterface

https://github.com/flowr-analysis/flowr/wiki/Interface

Hierarchy (View Summary)

DocMaker<"wiki/Interface.md">
- WikiInterface

Index

Constructors

Methods

didUpdate getProducer getTarget getWrittenSubfiles make normalizeText text writeSubFile

Constructors

constructor

new WikiInterface(): WikiInterface
Returns WikiInterface
Overrides DocMaker.constructor
- Defined in src/documentation/wiki-interface.ts:376

Methods

`Protected`didUpdate

didUpdate(
    path: PathLike,
    newText: string,
    oldText: string | undefined,
): WikiChangeType
Determines the type of change between the old and new text.
Parameters
- path: PathLike
- newText: string
- oldText: string | undefined
Returns WikiChangeType
Inherited from DocMaker.didUpdate
- Defined in src/documentation/wiki-mk/doc-maker.ts:167

getProducer

getProducer(): string
Gets the name of the producer of this wiki file.

Returns string
Inherited from DocMaker.getProducer
- Defined in src/documentation/wiki-mk/doc-maker.ts:108

getTarget

getTarget(): "wiki/Interface.md"
Gets the target path where the wiki file will be generated.

Returns "wiki/Interface.md"
Inherited from DocMaker.getTarget
- Defined in src/documentation/wiki-mk/doc-maker.ts:101

getWrittenSubfiles

getWrittenSubfiles(): Set<string>
Gets the set of subfiles written during the last make call.

Returns Set<string>
Inherited from DocMaker.getWrittenSubfiles
- Defined in src/documentation/wiki-mk/doc-maker.ts:115

make

make(args: DocMakerArgs & DocMakerOutputArgs): Promise<boolean>
Generates or updates the wiki file at the given target location.
Parameters
- args: DocMakerArgs & DocMakerOutputArgs
Returns Promise<boolean>
true if the file was created or updated, false if it was identical and not changed.
Inherited from DocMaker.make
- Defined in src/documentation/wiki-mk/doc-maker.ts:123

`Protected`normalizeText

normalizeText(text: string): string
Normalizes the given wiki text for comparison.
Parameters
- text: string
Returns string
Inherited from DocMaker.normalizeText
- Defined in src/documentation/wiki-mk/doc-maker.ts:155

`Protected`text

text(__namedParameters: DocMakerArgs): Promise<string>
Generates the wiki text for the given arguments. The text will be automatically prefixed with metadata including filename and purpose.
Parameters
- __namedParameters: DocMakerArgs
Returns Promise<string>
Overrides DocMaker.text
- Defined in src/documentation/wiki-interface.ts:380

`Protected`writeSubFile

writeSubFile(path: PathLike, data: string): boolean
Please note that for subfiles you have to always add your own header
Parameters
- path: PathLike
- data: string
Returns boolean
Inherited from DocMaker.writeSubFile
- Defined in src/documentation/wiki-mk/doc-maker.ts:139