IfStatementParser
Class: IfStatementParser
Defined in: packages/tagscript/src/lib/Parsers/Control.ts:54
The if tag returns a message based on the passed expression to the parameter.
An expression is represented by two values compared with an operator.
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.
Operators: {
Examples
{if(expression):message}{if({args}==63):You guessed it! The number I was thinking of was 63!|Too {if({args}<63):low|high}, try again.}
# if args is 63
# You guessed it! The number I was thinking of was 63!
# if args is 73
# Too high, try again.
# if args is 14
# Too low, try again.Extends
Implements
Constructors
Constructor
new IfStatementParser(): IfStatementParser
Defined in: packages/tagscript/src/lib/Parsers/Control.ts:55
Returns
IfStatementParser
Overrides
Properties
acceptedNames
protected acceptedNames: string[]
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:8
Inherited from
requiredParameter
protected requiredParameter: boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:10
Inherited from
requiredPayload
protected requiredPayload: boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:12
Inherited from
Methods
parse()
parse(ctx): string
Defined in: packages/tagscript/src/lib/Parsers/Control.ts:59
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
The context of the tag.
Returns
string
Implementation of
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
willAccept()
willAccept(ctx): boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:20
Whether the parser can handle the given tag.
Parameters
ctx
Returns
boolean