Class: UnionStatementParser
Defined in: 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
Extends
Implements
Constructors
new UnionStatementParser()
new UnionStatementParser(): UnionStatementParser
Defined in: Parsers/Control.ts:87
Returns
Overrides
Properties
acceptedNames
protected
acceptedNames: string
[]
Defined in: Parsers/Base.ts:8
Inherited from
requiredParameter
protected
requiredParameter: boolean
Defined in: Parsers/Base.ts:10
Inherited from
requiredPayload
protected
requiredPayload: boolean
Defined in: Parsers/Base.ts:12
Inherited from
Methods
parse()
parse(ctx
): string
Defined in: Parsers/Control.ts:91
Parses the given tag.
Parameters
ctx
The context of the tag.
Returns
string
Implementation of
toJSON()
toJSON(): object
Defined in: Parsers/Base.ts:29
Returns
object
acceptedNames
acceptedNames: string
[]
requiredParameter
requiredParameter: boolean
requiredPayload
requiredPayload: boolean
Inherited from
willAccept()
willAccept(ctx
): boolean
Defined in: Parsers/Base.ts:20
Whether the parser can handle the given tag.
Parameters
ctx
Returns
boolean