TypeDoc API
TagScript
classes
Includesparser

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

Hierarchy

Implements

Constructors

constructor

new IncludesParser()

Overrides

BaseParser.constructor

Properties

acceptedNames

Protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames


requiredParameter

Protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter


requiredPayload

Protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Methods

parse

parse(ctx): string

Parses the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

string

Implementation of

IParser.parse


willAccept

willAccept(ctx): boolean

Whether the parser can handle the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept