Matcher <Props, Options>

Implements

• MatcherInterface<Props>

Index

Constructors

• constructor

Properties

• factory
• greedy
• inverseName
• options
• propName

Methods

• asTag
• createElement
• doMatch
• match
• onAfterParse
• onBeforeParse
• replaceWith

Constructors

constructor

• new Matcher<Props, Options>(name: string, options?: Options, factory?: null | ComponentType<Props>): Matcher<Props, Options>

• Type parameters

  • Props: object = {}
  • Options: object = {}

Properties

factory

factory: null | ComponentType<Props>

greedy

greedy: boolean = false

Implementation of MatcherInterface.greedy

inverseName

inverseName: string

Implementation of MatcherInterface.inverseName

options

options: Options

propName

propName: string

Implementation of MatcherInterface.propName

Methods

abstractasTag

• asTag(): string

• Implementation of MatcherInterface.asTag

  Defines the HTML tag name that the resulting React element will be.

createElement

• createElement(children: ChildrenNode, props: Props): Node

• Implementation of MatcherInterface.createElement

  Attempts to create a React element using a custom user provided factory, or the default matcher factory.

doMatch

• doMatch<T>(string: string, pattern: string | RegExp, callback: MatchCallback<T>, isVoid?: boolean): null | MatchResponse<T>

• Trigger the actual pattern match and package the matched response through a callback.

  ---

  Type parameters

  • T

abstractmatch

• match(string: string): any

• Implementation of MatcherInterface.match

  Attempt to match against the defined string. Return null if no match found, else return the match and any optional props to pass along.

onAfterParse

• onAfterParse(content: Node[], props: Props): Node[]

• Implementation of MatcherInterface.onAfterParse

  Callback triggered after parsing.

onBeforeParse

• onBeforeParse(content: string, props: Props): string

• Implementation of MatcherInterface.onBeforeParse

  Callback triggered before parsing.

abstractreplaceWith

• replaceWith(children: ChildrenNode, props: Props): Node

• Replace the match with a React element based on the matched token and optional props.