session

Documentation

Index

• Constants
• func UUIDGenerator() string
• type Session
  • func NewCookieSession(cache cache.Cache, ctx *fiber.Ctx, secure bool, domain string, sameSite string, ...) Session
  • func NewHeaderSession(cache cache.Cache, ctx *fiber.Ctx, exp time.Duration, generator func() string, ...) Session

Constants

const (
	// SameSiteLax lax same site mode
	SameSiteLax string = "Lax"
	// SameSiteStrict strict same site mode
	SameSiteStrict = "Strict"
	// SameSiteNone none same site mode
	SameSiteNone = "None"
)

SameSiteType cookie session same site constants

Functions

func UUIDGenerator

func UUIDGenerator() string

UUIDGenerator Generate id using uuid

Types

type Session

type Session interface {
	// ID get session id
	ID() string
	// Context get request context
	Context() *fiber.Ctx
	// Parse parse session from request
	Parse() error
	// Regenerate regenerate session id
	Regenerate() error
	// Set set session value
	Set(key string, value any)
	// Get get session value
	Get(key string) any
	// Delete delete session value
	Delete(key string)
	// Exists check if session is exists
	Exists(key string) bool
	// Cast parse session item as caster
	Cast(key string) caster.Caster
	// Destroy session
	Destroy() error
	// Save session
	Save() error
}

Session interface

func NewCookieSession

func NewCookieSession(
	cache cache.Cache,
	ctx *fiber.Ctx,
	secure bool,
	domain string,
	sameSite string,
	exp time.Duration,
	generator func() string,
	name string,
) Session

NewCookieSession create new cookie based session

func NewHeaderSession

func NewHeaderSession(
	cache cache.Cache,
	ctx *fiber.Ctx,
	exp time.Duration,
	generator func() string,
	key string,
) Session

NewHeaderSession create new header based session