emd

Documentation

Index

• func ToGraphViz(emdString string) string
• type Command
• type Comment
• type Document
• type Emd
  • func Parse(emdInput []string) (Emd, error)
• type EmdValidationError
• type Event
• type Item
• type Parameter
• type Property

Functions

func ToGraphViz

func ToGraphViz(emdString string) string

ToGraphViz turns EMD into a GraphViz digraph which can be used to generate images of the event storming described by the EMD input

Types

type Command

type Command struct {
	Name       string
	Parameters []Parameter
}

Command in Event Markdown language Example: "Place Order-> // orderId, placedDate, deliveryDate"

type Comment

type Comment struct {
	Text string
}

A Comment in Event Markdown Example: "Order Placed"

type Document

type Document struct {
	Name       string
	Properties []Property
}

Document describes an emd read model document

type Emd

type Emd struct {
	Lines  []Item
	Errors []EmdValidationError `yaml:"Errors"` // The presence of errors means that no conversion to

}

Emd is a specification written in Event Markdown.

func Parse

func Parse(emdInput []string) (Emd, error)

Parse Event Markdown to Event Markup Language

type EmdValidationError

type EmdValidationError struct {
	ErrorID string
	Message string
}

A EmdValidationError means that the event markdown structure cannot be used to generate event markup.

type Event

type Event struct {
	Name       string
	Properties []Property
}

Event describes an emd event

type Item

type Item interface {
}

Item is a line item in an Event Markdown file.

type Parameter

type Parameter struct {
	Name string
}

A Parameter for an emd command

type Property

type Property struct {
	Name string
}

A Property of an emd event