headers

Documentation

Index

• Constants
• type CORSConfig
• type Config
  • func (c *Config) Hydrate(cfg service.Config) error
• type Service
  • func (s *Service) Init(cfg *Config, r *rrhttp.Service) (bool, error)

Constants

const ID = "headers"

ID contains default service name.

Types

type CORSConfig

type CORSConfig struct {
	// AllowedOrigin: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
	AllowedOrigin string

	// AllowedHeaders: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers
	AllowedHeaders string

	// AllowedMethods: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
	AllowedMethods string

	// AllowCredentials https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials
	AllowCredentials *bool

	// ExposeHeaders:  https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers
	ExposedHeaders string

	// MaxAge of CORS headers in seconds/
	MaxAge int
}

CORSConfig headers configuration.

type Config

type Config struct {
	// CORS settings.
	CORS *CORSConfig

	// Request headers to add to every payload send to PHP.
	Request map[string]string

	// Response headers to add to every payload generated by PHP.
	Response map[string]string
}

Config declares headers service configuration.

func (*Config) Hydrate

func (c *Config) Hydrate(cfg service.Config) error

Hydrate service config.

type Service

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

Service serves headers files. Potentially convert into middleware?

func (*Service) Init

func (s *Service) Init(cfg *Config, r *rrhttp.Service) (bool, error)

Init must return configure service and return true if service hasStatus enabled. Must return error in case of misconfiguration. Services must not be used without proper configuration pushed first.