cors

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)
• type Cors
  • func NewCorsWithConfigPath(path string) (*Cors, error)
  • func NewCorsWithOptions(options *Options) *Cors
  • func (d *Cors) Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

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

Register registers cors middleware for chi.

Types

type Cors

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

Cors struct which represents a native cors plugin for chi.

func NewCorsWithConfigPath

func NewCorsWithConfigPath(path string) (*Cors, error)

NewCorsWithConfigPath returns a new cors with options from config path.

func NewCorsWithOptions

func NewCorsWithOptions(options *Options) *Cors

NewCorsWithOptions returns a new cors with options.

func (*Cors) Register

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

Register registers the cors plugin to a new chi config.

type Options

type Options struct {
	Enabled bool
	Allowed struct {
		Origins     []string
		Headers     []string
		Methods     []string
		Credentials bool
	}
	Exposed struct {
		Headers []string
	}
	MaxAge int
}

Options struct which represents cors 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.