Tagscript

UnionStatementParser

TagScript


Class: UnionStatementParser

Defined in: packages/tagscript/src/lib/Parsers/Control.ts:86

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

Examples

{any(expression|expression|...):message}
{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.

Extends

Implements

Constructors

Constructor

new UnionStatementParser(): UnionStatementParser

Defined in: packages/tagscript/src/lib/Parsers/Control.ts:87

Returns

UnionStatementParser

Overrides

BaseParser.constructor

Properties

acceptedNames

protected acceptedNames: string[]

Defined in: packages/tagscript/src/lib/Parsers/Base.ts:8

Inherited from

BaseParser.acceptedNames


requiredParameter

protected requiredParameter: boolean

Defined in: packages/tagscript/src/lib/Parsers/Base.ts:10

Inherited from

BaseParser.requiredParameter


requiredPayload

protected requiredPayload: boolean

Defined in: packages/tagscript/src/lib/Parsers/Base.ts:12

Inherited from

BaseParser.requiredPayload

Methods

parse()

parse(ctx): string

Defined in: packages/tagscript/src/lib/Parsers/Control.ts:91

Parses the given tag.

Returning null or undefined means this parser did not handle the tag, and the interpreter moves on to the next one that accepted it.

Parameters

ctx

Context

The context of the tag.

Returns

string

Implementation of

IParser.parse


toJSON()

toJSON(): object

Defined in: packages/tagscript/src/lib/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: packages/tagscript/src/lib/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

On this page