api

Documentation

Index

• func FileSystemMiddleware(fallthroughHandler http.Handler, wdfs fs.FS) http.Handler
• func NoCache(handler http.Handler) http.Handler
• func RegisterConfigAPI(router *httprouter.Router, cfg *config.Components)
• func RegisterEventsAPI(router *httprouter.Router, hub *events.EventHub, logger *log.Logger)
• func RegisterViews(router *httprouter.Router, logger *log.Logger, wdfs fs.FS, mdFilepath string, ...)
• type ConfigAPI
  • func (a *ConfigAPI) MermaidConfig(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)
  • func (a *ConfigAPI) RevealConfig(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)
• type ContentEventHandler
  • func (h ContentEventHandler) Close() (err error)
  • func (h ContentEventHandler) OnEvent(ce events.ContentEvent) error
• type Events
  • func (e *Events) EventHandler(writer http.ResponseWriter, req *http.Request, _ httprouter.Params)
• type Views
  • func (p *Views) IndexPage(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)
  • func (p *Views) RenderedMarkdown(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)

Functions

func FileSystemMiddleware

func FileSystemMiddleware(fallthroughHandler http.Handler, wdfs fs.FS) http.Handler

func NoCache

func NoCache(handler http.Handler) http.Handler

func RegisterConfigAPI

func RegisterConfigAPI(router *httprouter.Router, cfg *config.Components)

func RegisterEventsAPI

func RegisterEventsAPI(router *httprouter.Router, hub *events.EventHub, logger *log.Logger)

func RegisterViews

func RegisterViews(router *httprouter.Router, logger *log.Logger, wdfs fs.FS, mdFilepath string, cfg *config.Components)

Types

type ConfigAPI

type ConfigAPI struct {
	// contains filtered or unexported fields
}

func (*ConfigAPI) MermaidConfig

func (a *ConfigAPI) MermaidConfig(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)

func (*ConfigAPI) RevealConfig

func (a *ConfigAPI) RevealConfig(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)

type ContentEventHandler

type ContentEventHandler chan events.ContentEvent

func (ContentEventHandler) Close

func (h ContentEventHandler) Close() (err error)

func (ContentEventHandler) OnEvent

func (h ContentEventHandler) OnEvent(ce events.ContentEvent) error

type Events

type Events struct {
	// contains filtered or unexported fields
}

func (*Events) EventHandler

func (e *Events) EventHandler(writer http.ResponseWriter, req *http.Request, _ httprouter.Params)

type Views

type Views struct {
	// contains filtered or unexported fields
}

func (*Views) IndexPage

func (p *Views) IndexPage(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)

func (*Views) RenderedMarkdown

func (p *Views) RenderedMarkdown(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)