web

package

v0.1.19 Latest Latest Go to latest Published: Jul 8, 2026 License: AGPL-3.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dcadolph/whodar

Links

Open Source Insights

Documentation ¶

Overview ¶

Package web serves the whodar web UI: a search page and a JSON ask API over the same engine the CLI uses.

Index ¶

func Handler(cfg Config) (http.Handler, error)
type AskFunc
type Config
type FeedbackFunc
type PersonFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Handler ¶

func Handler(cfg Config) (http.Handler, error)

Handler returns the whodar web handler: an index page, embedded assets, and a JSON ask API. It panics if cfg.Ask is nil.

Types ¶

type AskFunc ¶

type AskFunc func(ctx context.Context, query, mode string, limit int) (resolve.Answer, error)

AskFunc resolves a query in the chosen mode and returns the answer.

type Config ¶

type Config struct {
	// Ask resolves queries; required.
	Ask AskFunc
	// Feedback records votes on results; nil disables the feedback API.
	Feedback FeedbackFunc
	// Person returns full person profiles; nil disables the person API.
	Person PersonFunc
	// Version is shown in the page footer.
	Version string
}

Config configures the web handler.

type FeedbackFunc ¶ added in v0.1.10

type FeedbackFunc func(feedback.Entry) error

FeedbackFunc records a user's vote on one result.

type PersonFunc ¶ added in v0.1.15

type PersonFunc func(id string) (resolve.JSONProfile, bool)

PersonFunc returns the full profile for a person identifier, or false when the person is unknown.

Source Files ¶

View all Source files

web.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL