recoverer

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 Recoverer
  • func NewRecovererWithConfigPath(path string) (*Recoverer, error)
  • func NewRecovererWithOptions(options *Options) *Recoverer
  • func (d *Recoverer) 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 recoverer middleware for chi.

Types

type Options

type Options struct {
	Enabled bool
}

Options struct which represents recoverer plugin from chi 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 Recoverer

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

Recoverer struct which represents a recoverer middleware for chi.

func NewRecovererWithConfigPath

func NewRecovererWithConfigPath(path string) (*Recoverer, error)

NewRecovererWithConfigPath returns a recoverer middleware with options from config path.

func NewRecovererWithOptions

func NewRecovererWithOptions(options *Options) *Recoverer

NewRecovererWithOptions returns a recoverer middleware with options.

func (*Recoverer) Register

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

Register registers this recoverer middleware on a new chi config.