TagScript API Docs Getting StartedClasses

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

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

BaseParser

Implements

IParser

Constructors

new UnionStatementParser()

new UnionStatementParser(): UnionStatementParser

Returns

UnionStatementParser

Overrides

BaseParser.constructor

Defined in

Parsers/Control.ts:87

Properties

acceptedNames

protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames

Defined in

Parsers/Base.ts:8

requiredParameter

protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter

Defined in

Parsers/Base.ts:10

requiredPayload

protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Defined in

Parsers/Base.ts:12

Methods

parse()

parse(ctx): string

Parses the given tag.

Parameters

• ctx: Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

Defined in

Parsers/Control.ts:91

toJSON()

toJSON(): object

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON

Defined in

Parsers/Base.ts:29

willAccept()

willAccept(ctx): boolean

Whether the parser can handle the given tag.

Parameters

• ctx: Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

Defined in

Parsers/Base.ts:20

Previous

StringTransformer

Next

UrlDecodeParser