Tagscript

tagscript


Class: OrdinalFormatParser

Defined in: Parsers/Format.ts:43

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

Extends

Implements

Constructors

new OrdinalFormatParser()

new OrdinalFormatParser(): OrdinalFormatParser

Defined in: Parsers/Format.ts:44

Returns

OrdinalFormatParser

Overrides

BaseParser.constructor

Properties

acceptedNames

protected acceptedNames: string[]

Defined in: Parsers/Base.ts:8

Inherited from

BaseParser.acceptedNames


requiredParameter

protected requiredParameter: boolean

Defined in: Parsers/Base.ts:10

Inherited from

BaseParser.requiredParameter


requiredPayload

protected requiredPayload: boolean

Defined in: Parsers/Base.ts:12

Inherited from

BaseParser.requiredPayload

Methods

parse()

parse(ctx): null | string

Defined in: Parsers/Format.ts:48

Parses the given tag.

Parameters

ctx

Context

The context of the tag.

Returns

null | string

Implementation of

IParser.parse


toJSON()

toJSON(): object

Defined in: Parsers/Base.ts:29

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON


willAccept()

willAccept(ctx): boolean

Defined in: Parsers/Base.ts:20

Whether the parser can handle the given tag.

Parameters

ctx

Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept