Interface ParseWikilinksConfig

Configuration options for Wikitext.parseWikilinks.

interface ParseWikilinksConfig {
titlePredicate?: (title: string | Title) => boolean;
wikilinkPredicate?: (wikilink: DoubleBracketedClasses) => boolean;
}

Index

Properties

titlePredicate? wikilinkPredicate?

Properties

`Optional`titlePredicate

titlePredicate?: (title: string | Title) => boolean

A predicate function to filter wikilinks by title. Only wikilinks whose titles satisfy this function will be included in the results.

Type declaration

- (title: string | Title): boolean
- Parameters
  - title: string | Title
    A Title object for ParsedWikilink and ParsedFileWikilink instances, or a string for ParsedRawWikilink instances.
  Returns boolean
  true if the wikilink should be parsed, otherwise false.

`Optional`wikilinkPredicate

wikilinkPredicate?: (wikilink: DoubleBracketedClasses) => boolean

A predicate function to filter parsed wikilinks. Only wikilinks that satisfy this function will be included in the results.

Type declaration

- (wikilink: DoubleBracketedClasses): boolean
- Parameters
  - wikilink: DoubleBracketedClasses
    The (file) wikilink object.
  Returns boolean
  true if the wikilink should be included, otherwise false.