echosessions

Documentation

Index

• Variables
• func Destroy(name string, c echo.Context) error
• func Get(name string, c echo.Context) (*sessions.Session[string], error)
• func Middleware(store sessions.Store[string]) echo.MiddlewareFunc
• func MiddlewareWithConfig(config Config) echo.MiddlewareFunc
• func New(name string, c echo.Context) (*sessions.Session[string], error)
• type Config

Variables

var (
	// DefaultConfig is the default Session middleware config.
	DefaultConfig = Config{
		Skipper: middleware.DefaultSkipper,
	}
)

Functions

func Destroy

func Destroy(name string, c echo.Context) error

Destroy destroy existing session

func Get

func Get(name string, c echo.Context) (*sessions.Session[string], error)

Get returns a named session.

func Middleware

func Middleware(store sessions.Store[string]) echo.MiddlewareFunc

Middleware returns a Session middleware.

func MiddlewareWithConfig

func MiddlewareWithConfig(config Config) echo.MiddlewareFunc

MiddlewareWithConfig returns a Sessions middleware with config. See `Middleware()`.

func New

func New(name string, c echo.Context) (*sessions.Session[string], error)

New returns a new session

Types

type Config

type Config struct {
	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper

	// Session store.
	// Required.
	Store sessions.Store[string]
}

Config defines the config for Session middleware.