cors

Documentation

Index

• type Option
  • func AllowCredentials(allow bool) Option
  • func AllowedHeaders(headers []string) Option
  • func AllowedMethods(methods []string) Option
  • func AllowedOrigins(origins []string) Option
  • func Logger(l log.Logger) Option
• type Options
  • func NewOptions(opts ...Option) Options

Types

type Option

type Option func(o *Options)

Option defines a single option function.

func AllowCredentials

func AllowCredentials(allow bool) Option

AlloweCredentials provides a function to set the AllowCredentials option.

func AllowedHeaders

func AllowedHeaders(headers []string) Option

AllowedHeaders provides a function to set the AllowedHeaders option.

func AllowedMethods

func AllowedMethods(methods []string) Option

AllowedMethods provides a function to set the AllowedMethods option.

func AllowedOrigins

func AllowedOrigins(origins []string) Option

AllowedOrigins provides a function to set the AllowedOrigins option.

func Logger

func Logger(l log.Logger) Option

Logger provides a function to set the logger option.

type Options

type Options struct {
	// Logger to use for logging, must be set
	Logger log.Logger
	// AllowedOrigins represents the allowed CORS origins
	AllowedOrigins []string
	// AllowedMethods represents the allowed CORS methods
	AllowedMethods []string
	// AllowedHeaders represents the allowed CORS headers
	AllowedHeaders []string
	// AllowCredentials represents the AllowCredentials CORS option
	AllowCredentials bool
}

Options defines the available options for this package.

func NewOptions

func NewOptions(opts ...Option) Options

newAccountOptions initializes the available default options.