Class: StringFormatParser

This tag formats a given string.

Example

{lower:Hello Parbez!}
# hello parbez!
{upper:Hello Parbez!}
# HELLO PARBEZ!
{capitalize:hello parbez!}
# Hello parbez!
{escape:Hello| Parbez!}
# Hello\\| Parbez!

Extends

BaseParser

Implements

IParser

Constructors

new StringFormatParser()

new StringFormatParser(): StringFormatParser

Defined in: Parsers/Format.ts:24

Returns

StringFormatParser

Overrides

BaseParser.constructor

Properties

acceptedNames

protected acceptedNames: string[]

Defined in: Parsers/Base.ts:8

Inherited from

BaseParser.acceptedNames

requiredParameter

protected requiredParameter: boolean

Defined in: Parsers/Base.ts:10

Inherited from

BaseParser.requiredParameter

requiredPayload

protected requiredPayload: boolean

Defined in: Parsers/Base.ts:12

Inherited from

BaseParser.requiredPayload

Methods

parse()

parse(ctx): string

Defined in: Parsers/Format.ts:28

Parses the given tag.

Parameters

ctx

Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

toJSON()

toJSON(): object

Defined in: Parsers/Base.ts:29

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON

willAccept()

willAccept(ctx): boolean

Defined in: Parsers/Base.ts:20

Whether the parser can handle the given tag.

Parameters

ctx

Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

On this page