commons

Documentation

Index

• Constants
• func NewFn[P any, R any](name string, handler FnHandler[P, R], options ...FnOption) services.Fn
• type Fn
  • func (fn *Fn[P, R]) Handle(r services.Request) (v interface{}, err error)
  • func (fn *Fn[P, R]) Internal() bool
  • func (fn *Fn[P, R]) Name() string
  • func (fn *Fn[P, R]) Readonly() bool
• type FnHandler
• type FnOption
  • func Authorization() FnOption
  • func Barrier() FnOption
  • func Cache(mod string, param string) FnOption
  • func CacheControl(maxAge int, public bool, mustRevalidate bool, proxyRevalidate bool) FnOption
  • func Deprecated() FnOption
  • func Internal() FnOption
  • func Metric() FnOption
  • func Permission() FnOption
  • func Readonly() FnOption
  • func Validation(title string) FnOption
• type FnOptions

Constants

const (
	GetCacheMod    = "get"
	GetSetCacheMod = "get-set"
	SetCacheMod    = "set"
	RemoveCacheMod = "remove"
)

Functions

func NewFn

func NewFn[P any, R any](name string, handler FnHandler[P, R], options ...FnOption) services.Fn

Types

type Fn

type Fn[P any, R any] struct {
	// contains filtered or unexported fields
}

Fn builtin fn handler wrapper supported annotations @fn {name} @readonly @authorization @permission @validation @cache {get} {set} {get-set} {remove} {ttl} @cache-control {max-age=sec} {public=true} {must-revalidate} {proxy-revalidate} @barrier @metric @title {title} @description >>> {description} <<< @errors >>> {error_name} zh: {zh_message} en: {en_message} <<<

func (*Fn[P, R]) Handle

func (fn *Fn[P, R]) Handle(r services.Request) (v interface{}, err error)

func (*Fn[P, R]) Internal

func (fn *Fn[P, R]) Internal() bool

func (*Fn[P, R]) Name

func (fn *Fn[P, R]) Name() string

func (*Fn[P, R]) Readonly

func (fn *Fn[P, R]) Readonly() bool

type FnHandler

type FnHandler[P any, R any] func(ctx context.Context, param P) (v R, err error)

type FnOption

type FnOption func(opt *FnOptions) (err error)

func Authorization

func Authorization() FnOption

func Barrier

func Barrier() FnOption

func Cache

func Cache(mod string, param string) FnOption

func CacheControl

func CacheControl(maxAge int, public bool, mustRevalidate bool, proxyRevalidate bool) FnOption

func Deprecated

func Deprecated() FnOption

func Internal

func Internal() FnOption

func Metric

func Metric() FnOption

func Permission

func Permission() FnOption

func Readonly

func Readonly() FnOption

func Validation

func Validation(title string) FnOption

type FnOptions

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