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

Returns

StringFormatParser

Overrides

BaseParser.constructor

Source

lib/Parsers/Format.ts:24

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/Format.ts:28

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