web

package

v0.8.4 Latest Latest Go to latest Published: Oct 11, 2022 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func ToUser(c context.Context) (*model.User, bool)

ToUser returns a user from the context.

func WithUser(c context.Context, user *model.User) context.Context

WithUser returns a context with the current authenticated user.

type Endpoint interface {
	// Register registers the provider endpoints.
	Register(*httptreemux.ContextMux)
}

Endpoint provides the website endpoints.

func New(opt ...Option) Endpoint

New returns the default website endpoint.

type Option func(*Options)

Option configures the website handler.

func WithDir(s string) Option

WithDir configures the website hanlder with the directory value used to serve the website from the local filesystem.

func WithDocs(s string) Option

WithDocs configures the website hanlder with the documentation website address, which should be included in the user interface.

func WithSync(d time.Duration) Option

WithSync configures the website hanlder with the duration value used to determine if the user account requires synchronization.

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

Options defines website handler options.