cors

Documentation

Index

• type CompletedConfig
  • func (c CompletedConfig) New() *cors.Cors
  • func (c CompletedConfig) NewGinHandler() gin.HandlerFunc
  • func (c CompletedConfig) NewWrapper() func(http.Handler) http.Handler
• type Config
  • func NewConfig() *Config
  • func (s *Config) Complete() CompletedConfig
  • func (s *Config) Validate() []error

Types

type CompletedConfig

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

func (CompletedConfig) New

func (c CompletedConfig) New() *cors.Cors

func (CompletedConfig) NewGinHandler

func (c CompletedConfig) NewGinHandler() gin.HandlerFunc

func (CompletedConfig) NewWrapper

func (c CompletedConfig) NewWrapper() func(http.Handler) http.Handler

type Config

type Config struct {
	// returns Access-Control-Allow-Origin: * if false
	UseConditional bool

	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	// If the special "*" value is present in the list, all origins will be allowed.
	// An origin may contain a wildcard (*) to replace 0 or more characters
	// (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penalty.
	// Only one wildcard can be used per origin.
	// Default value is ["*"]
	AllowedOrigins []string
	// AllowedMethods is a list of methods the client is allowed to use with
	// cross-domain requests. Default value is simple methods (HEAD, GET and POST).
	AllowedMethods []string
	// AllowedHeaders is list of non simple headers the client is allowed to use with
	// cross-domain requests.
	// If the special "*" value is present in the list, all headers will be allowed.
	// Default value is [] but "Origin" is always appended to the list.
	AllowedHeaders []string
	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS
	// API specification
	ExposedHeaders []string
	// MaxAge indicates how long (in seconds) the results of a preflight request
	// can be cached
	MaxAge time.Duration
	// AllowCredentials indicates whether the request can include user credentials like
	// cookies, HTTP authentication or client side SSL certificates.
	AllowCredentials bool
	// OptionsPassthrough instructs preflight to let other potential next handlers to
	// process the OPTIONS method. Turn this on if your application handles OPTIONS.
	OptionsPassthrough bool
}

func NewConfig

func NewConfig() *Config

NewConfig returns a Config struct with the default values

func (*Config) Complete

func (s *Config) Complete() CompletedConfig

Complete fills in any fields not set that are required to have valid data and can be derived from other fields. If you're going to `ApplyOptions`, do that first. It's mutating the receiver.

func (*Config) Validate

func (s *Config) Validate() []error

Validate checks Config and return a slice of found errs.