Class: IncludesParser
This tag serves four different purposes depending on the alias that is used.
The in
and includes
alias checks if the parameter is anywhere in the payload.
contain
strictly checks if the parameter is the payload, split by whitespace.
index
finds the location of the parameter in the payload, split by whitespace.
lindex
finds the location of the parameter in the payload.
Aliases: includes, in, index, lindex, contain,
Example
Extends
Implements
Constructors
new IncludesParser()
new IncludesParser(): IncludesParser
Returns
Overrides
Defined in
Properties
acceptedNames
protected
acceptedNames: string
[]
Inherited from
Defined in
requiredParameter
protected
requiredParameter: boolean
Inherited from
Defined in
requiredPayload
protected
requiredPayload: boolean
Inherited from
Defined in
Methods
parse()
parse(ctx
): string
Parses the given tag.
Parameters
ctx
The context of the tag.
Returns
string
Implementation of
Defined in
toJSON()
toJSON(): object
Returns
object
acceptedNames
acceptedNames: string
[]
requiredParameter
requiredParameter: boolean
requiredPayload
requiredPayload: boolean
Inherited from
Defined in
willAccept()
willAccept(ctx
): boolean
Whether the parser can handle the given tag.
Parameters
ctx
Returns
boolean