engine

Documentation

Index

• type Engine
  • func New(what string, config *types.Config, fsys fs.FS) (Engine, error)

Types

type Engine

type Engine interface {
	// Meta will extract meta information from a template
	Meta(tpl *types.Template) (map[string]interface{}, error)

	ExportAccounts(writer io.Writer, tpl *types.Template, accounts []*types.Account) error
	ExportClients(writer io.Writer, tpl *types.Template, clients []*types.Client) error
	ExportProjects(writer io.Writer, tpl *types.Template, projects []*types.Project) error
	ExportInvoices(writer io.Writer, tpl *types.Template, invoices []*types.Invoice, account *types.Account) error
}

Engine interface represents various exporting engines

func New

func New(what string, config *types.Config, fsys fs.FS) (Engine, error)

New will attempt to create an exporting engine given the name of the engine, general configuration and a file system that contains assets that may be referenced in the templates.