dash

package
v1.53.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2025 License: MPL-2.0 Imports: 38 Imported by: 0

Documentation

Overview

Package dash serves the Encore Developer Dashboard.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type QueryRequest added in v1.50.1 

type QueryRequest struct {
	Query     string `json:"query"`
	Params    []any  `json:"params"`
	ArrayMode bool   `json:"arrayMode"`
	DbID      string `json:"dbId"`
	AppID     string `json:"appId"`
}

QueryRequest represents the request body for the /query endpoint

type Server 

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

Server is the http.Handler for serving the developer dashboard.

func NewServer 

func NewServer(appsMgr *apps.Manager, runMgr *run.Manager, nsMgr *namespace.Manager, tr trace2.Store, dashPort int) *Server

NewServer starts a new server and returns it.

func (*Server) OnCompileStart added in v1.31.0 

func (s *Server) OnCompileStart(r *run.Run)

func (*Server) OnError added in v1.8.0 

func (s *Server) OnError(r *run.Run, err *errlist.List)

func (*Server) OnReload 

func (s *Server) OnReload(r *run.Run)

OnReload notifies active websocket clients about the reloaded run.

func (*Server) OnStart 

func (s *Server) OnStart(r *run.Run)

OnStart notifies active websocket clients about the started run.

func (*Server) OnStderr 

func (s *Server) OnStderr(r *run.Run, out []byte)

OnStderr forwards the output to active websocket clients.

func (*Server) OnStdout 

func (s *Server) OnStdout(r *run.Run, out []byte)

OnStdout forwards the output to active websocket clients.

func (*Server) OnStop 

func (s *Server) OnStop(r *run.Run)

OnStop notifies active websocket clients about the stopped run.

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Server) WebSocket 

func (s *Server) WebSocket(w http.ResponseWriter, req *http.Request)

WebSocket serves the jsonrpc2 API over WebSocket.

type TransactionRequest added in v1.50.1 

type TransactionRequest struct {
	Queries []struct {
		SQL    string `json:"sql"`
		Params []any  `json:"params"`
	} `json:"queries"`
	DbID  string `json:"dbId"`
	AppID string `json:"appId"`
}

TransactionRequest represents the request body for the /transaction endpoint

Source Files

View all Source files

Directories

Path Synopsis
Package dashproxy proxies requests to the dash server, caching them locally for offline access.
 Package dashproxy proxies requests to the dash server, caching them locally for offline access.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.