TypeDoc API
TagScript
classes
Unionstatementparser

Class: UnionStatementParser

The union parser checks that any of the passed expressions are true. Multiple expressions can be passed to the parameter by splitting them with pipe (|). The payload is a required message that must be split by pipe (|). If the expression evaluates true, then the message before the pipe (|) is returned, else the message after is returned.

Aliases: or, union

Example

{any(expression|expression|...):message}

Example

{any({args}==hi|{args}==hello|{args}==hey):Hello {user}!|How rude.}
# if {args} is hi
Hello Mr. Priyansh#2063!
# if {args} is what's up
How rude.

Hierarchy

Implements

Constructors

constructor

new UnionStatementParser()

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