TypeDoc API
TagScript
interfaces
Iparser

Interface: IParser

Parsers are used to parse a tag and return a value based on the tag.

Implemented by

Methods

parse

parse(ctx): Awaitable<null | string>

Parses the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

Awaitable<null | string>


willAccept

willAccept(ctx): Awaitable<boolean>

Whether the parser can handle the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

Awaitable<boolean>