status

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
• type Status
  • func NewStatus() *Status
  • func NewStatusWithConfigPath(path string) (*Status, error)
  • func NewStatusWithOptions(options *Options) *Status
  • func (i *Status) Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Register registers a default status to a new chi config.

Types

type Options

type Options struct {
	Enabled bool
	Route   string
}

Options struct that represents a chi status options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.

type Status

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

Status struct that represents a status router plugin.

func NewStatus

func NewStatus() *Status

NewStatus returns a status router with default options.

func NewStatusWithConfigPath

func NewStatusWithConfigPath(path string) (*Status, error)

NewStatusWithOptions returns a status router with options from config path.

func NewStatusWithOptions

func NewStatusWithOptions(options *Options) *Status

NewStatusWithOptions returns a status router with options.

func (*Status) Register

func (i *Status) Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Register registers the status router to a new chi config.