modules.md

hydrographer

Table of contents

Classes

• ArrayChild
• ArrayContainer
• ArrayField
• Block
• BlockChild
• BooleanField
• BooleanPrimitive
• CompoundExpression
• Container
• Expression
• Field
• FunctionExpression
• IfBlock
• Node
• NullField
• NullPrimitive
• NumberField
• NumberPrimitive
• ObjectChild
• ObjectContainer
• ObjectField
• PipeExpression
• Primitive
• StringField
• StringPrimitive

Interfaces

• Builder
• BuilderMethods

Type aliases

• ExpressionType
• Template

Variables

• Chart
• Release
• Values
• fn

Functions

• parse
• print

Type aliases

ExpressionType

Ƭ ExpressionType: "null" | "string" | "number" | "boolean" | "array" | "object"

Defined in

ast.ts:101

---

Template

Ƭ Template: null | string | number | boolean | Expression<ExpressionType> | Block | Template[] | { [key: string]: Template; }

Defined in

parse.ts:16

Variables

Chart

• Const Chart: Readonly<Object>

Defined in

index.ts:36

---

Release

• Const Release: Readonly<Object>

Defined in

index.ts:54

---

Values

• Const Values: Builder

Defined in

index.ts:62

---

fn

• Const fn: Object

Type declaration

Name	Type
if	(condition: Expression<ExpressionType>, block: Template) => IfBlock
toYaml	(input: Expression<ExpressionType>) => Expression<ExpressionType>

Defined in

index.ts:66

Functions

parse

▸ parse(template): Node

Parameters

Name	Type
template	Template

Returns

Node

Defined in

parse.ts:26

---

print

▸ print(node): string

Parameters

Name	Type
node	Node

Returns

string

Defined in

print.ts:20