Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
Types ¶
type DBTXWithBegin ¶
type HandlerOpts ¶ added in v0.12.0
type HandlerOpts struct {
// Client is the River client to use for API requests.
Client *river.Client[pgx.Tx]
// DBPool is the database connection pool to use for API requests.
DBPool DBTXWithBegin
// DevMode is whether the server is running in development mode.
DevMode bool
// LiveFS is whether to use the live filesystem for the frontend.
LiveFS bool
// Logger is the logger to use logging errors within the handler.
Logger *slog.Logger
// Prefix is the path prefix to use for the API and UI HTTP requests.
Prefix string
}
HandlerOpts are the options for creating a new Handler.
type RiverJob ¶
type RiverJob struct {
ID int64 `json:"id"`
Args json.RawMessage `json:"args"`
Attempt int `json:"attempt"`
AttemptedAt *time.Time `json:"attempted_at"`
AttemptedBy []string `json:"attempted_by"`
CreatedAt time.Time `json:"created_at"`
Errors []rivertype.AttemptError `json:"errors"`
FinalizedAt *time.Time `json:"finalized_at"`
Kind string `json:"kind"`
MaxAttempts int `json:"max_attempts"`
Metadata json.RawMessage `json:"metadata"`
Priority int `json:"priority"`
Queue string `json:"queue"`
ScheduledAt time.Time `json:"scheduled_at"`
State string `json:"state"`
Tags []string `json:"tags"`
}
type RiverQueue ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func NewServer ¶
func NewServer(opts *HandlerOpts) (*Server, error)
NewServer creates a new http.Handler that serves the River UI and API.
func (*Server) Handler ¶
Handler returns an http.Handler that can be mounted to serve HTTP requests.
Source Files
¶
- embed.go
- handler.go
- handler_api_endpoint.go
- int64_string.go
- spa_response_writer.go
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
riverui
command
|
|
|
internal
|
|
|
apiendpoint
Package apiendpoint provides a lightweight API framework for use with River UI.
|
Package apiendpoint provides a lightweight API framework for use with River UI. |
|
apierror
Package apierror contains a variety of marshalable API errors that adhere to a unified error response convention.
|
Package apierror contains a variety of marshalable API errors that adhere to a unified error response convention. |
|
validate
Package validate internalizes Go Playground's Validator framework, setting some common options that we use everywhere, providing some useful helpers, and exporting a simplified API.
|
Package validate internalizes Go Playground's Validator framework, setting some common options that we use everywhere, providing some useful helpers, and exporting a simplified API. |
|
riverproui
module
|
Click to show internal directories.
Click to hide internal directories.