TypeDoc API
TagScript
classes
Ordinalformatparser

Class: OrdinalFormatParser

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

Hierarchy

Implements

Constructors

constructor

new OrdinalFormatParser()

Overrides

BaseParser.constructor

Properties

acceptedNames

Protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames


requiredParameter

Protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter


requiredPayload

Protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Methods

parse

parse(ctx): null | string

Parses the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

null | string

Implementation of

IParser.parse


willAccept

willAccept(ctx): boolean

Whether the parser can handle the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept