🚧 The guide is still incomplete. Please read the typedoc generated api docs instead →

Class: IfStatementParser

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: {

Operator	Check	Example	Description
==	equality	a==a	value 1 is equal to value 2
!=	inequality	a!=b	value 1 is not equal to value 2
>	greater than	5>3	value 1 is greater than value 2
<	less than	4<8	value 1 is less than value 2
>=	greater than or equality	10>=10	value 1 is greater than or equal to value 2
<=	less than or equality	5<=6	value 1 is less than or equal to value 2

}

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

BaseParser

Implements

IParser

Constructors

new IfStatementParser()

new IfStatementParser(): IfStatementParser

Returns

IfStatementParser

Overrides

BaseParser.constructor

Source

lib/Parsers/Control.ts:55

Properties

acceptedNames

protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames

Source

lib/Parsers/Base.ts:8

requiredParameter

protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter

Source

lib/Parsers/Base.ts:10

requiredPayload

protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Source

lib/Parsers/Base.ts:12

Methods

parse()

parse(ctx): string

Parameters

• ctx: Context

Returns

string

Implementation of

IParser.parse

Source

lib/Parsers/Control.ts:59

toJSON()

toJSON(): object

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON

Source

lib/Parsers/Base.ts:29

willAccept()

willAccept(ctx): boolean

Parameters

• ctx: Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

Source

lib/Parsers/Base.ts:20

Functiontransformer Includesparser