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

{in(there):Hi there!}
# true
	    {contain(there):Hi there!}
# false
{contain(there!):Hi there!}
# true
{index(there):Hi there!}
	    # 1
{lindex(t):Hi there!}
# 4

Extends

• BaseParser

Implements

• IParser

Constructors

new IncludesParser()

Returns

IncludesParser

Overrides

BaseParser.constructor

Defined in

Parsers/Includes.ts:29

Properties

acceptedNames

Inherited from

BaseParser.acceptedNames

Defined in

Parsers/Base.ts:8

requiredParameter

Inherited from

BaseParser.requiredParameter

Defined in

Parsers/Base.ts:10

requiredPayload

Inherited from

BaseParser.requiredPayload

Defined in

Parsers/Base.ts:12

Methods

parse()

Parses the given tag.

Parameters

• ctx: Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

Defined in

Parsers/Includes.ts:33

toJSON()

Returns

object

acceptedNames

requiredParameter

requiredPayload

Inherited from

BaseParser.toJSON

Defined in

Parsers/Base.ts:29

willAccept()

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