recipe

Documentation

Index

• Variables
• type Recipe
  • func RecipesFromPath(dirPath string) (recipes []*Recipe, err error)
  • func (r *Recipe) ParseFiles() error
  • func (r *Recipe) Summary() (output string)

Variables

var ValidCategoriesOrder = []string{
	"serves",
	"oven temperature",
	"ingredients",
	"preparation",
	"tips",
}

ValidCategoriesOrder defines keys of info in order of importance

Types

type Recipe

type Recipe struct {
	Title string              `json:"title"`
	Info  map[string][]string `json:"info"`
	// FIXME support non-docx
	DocxPath  string   `json:"docx_path"`
	ScanPaths []string `json:"scan_paths"`
	Image     []byte
}

Recipe stores information regarding a specific recipe

func RecipesFromPath

func RecipesFromPath(dirPath string) (recipes []*Recipe, err error)

RecipesFromPath generates Recipe instances from a path

func (*Recipe) ParseFiles

func (r *Recipe) ParseFiles() error

ParseFiles for the recipe

func (*Recipe) Summary

func (r *Recipe) Summary() (output string)

Summary outputs a nice summary of Info