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()

new IncludesParser(): IncludesParser

Returns

IncludesParser

Overrides

BaseParser.constructor

Source

lib/Parsers/Includes.ts:29

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/Includes.ts:33

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