Skip to content

Parser

Template parser definition

---
title: Parser
config:
  look: handDrawn
  theme: colorful
  class:
    hideEmptyMembersBox: true
---
classDiagram
    class Parser {
      
        +string kind
        +dictionary options
    }
kind: prompty
options:
key: value
NameTypeDescription
kindstringParser used to process the rendered template into API-compatible format
optionsdictionaryOptions for the parser

The following alternate constructions are available for Parser. These allow for simplified creation of instances using a single property.

Simple construction with just a “kind” string

The following simplified representation can be used:

parser: "example"

This is equivalent to the full representation:

parser:
kind: "example"