TypeDoc API
TagScript
classes
Defineparser

Class: DefineParser

Variables are useful for choosing a value and referencing it later in a tag. It can be referenced using brackets as any other tag.

Aliases: assign, let, var

Example

{=(name):value}

Example

{=(prefix):!}
The prefix here is `{prefix}`.

Hierarchy

Implements

Constructors

constructor

new DefineParser()

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): string

Parses the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

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