siyouyunsdk

README

siyouyun_sdk

Siyouyun Mini App SDK

Documentation

Index

• Constants
• type Ability
  • func (a *Ability) AI() (*ability.AI, error)
  • func (a *Ability) Destroy()
  • func (a *Ability) FFmpeg() (*ability.FFmpeg, error)
  • func (a *Ability) FS() *ability.FS
  • func (a *Ability) KV() (*ability.KV, error)
  • func (a *Ability) Message() (*ability.Message, error)
  • func (a *Ability) Schedule() (*ability.Schedule, error)
• type AbilityInterface
• type AppBuilder
  • func NewAppBuilder(appCode string) *AppBuilder
  • func (b *AppBuilder) Build()
  • func (b *AppBuilder) WithDB(db *gorm.DB) *AppBuilder
  • func (b *AppBuilder) WithNC(nc *nats.Conn) *AppBuilder
  • func (b *AppBuilder) WithWebServer() *AppBuilder
• type AppStruct
  • func NewApp() *AppStruct
  • func (a *AppStruct) Destroy()
  • func (a *AppStruct) GetAPIBuilder() *router.APIBuilder
  • func (a *AppStruct) GetIcon(ctx iris.Context)
  • func (a *AppStruct) InitAbility()
  • func (a *AppStruct) StartWebServer()
  • func (a *AppStruct) WithAI()
  • func (a *AppStruct) WithFFmpeg()
  • func (a *AppStruct) WithFS()
  • func (a *AppStruct) WithFileEventMonitor(preferOps ...sdkdto.PreferOptions)
  • func (a *AppStruct) WithKV()
  • func (a *AppStruct) WithMessage()
  • func (a *AppStruct) WithMigrator(migrator ability.IMigrator)
  • func (a *AppStruct) WithSchedule()
• type ModelMigrator
  • func NewModelMigrator(models ...any) *ModelMigrator
  • func (m *ModelMigrator) Migrate(ugn *utils.UserGroupNamespace) error

Constants

const (
	AppCodeEnvKey = "APPCODE"
)

Types

type Ability

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

Ability app ability set

func (*Ability) AI

func (a *Ability) AI() (*ability.AI, error)

func (*Ability) Destroy

func (a *Ability) Destroy()

func (*Ability) FFmpeg

func (a *Ability) FFmpeg() (*ability.FFmpeg, error)

func (*Ability) FS

func (a *Ability) FS() *ability.FS

func (*Ability) KV

func (a *Ability) KV() (*ability.KV, error)

func (*Ability) Message

func (a *Ability) Message() (*ability.Message, error)

func (*Ability) Schedule

func (a *Ability) Schedule() (*ability.Schedule, error)

type AbilityInterface

type AbilityInterface interface {
	// Name of ability
	Name() string
	// Close resources
	Close()
}

AbilityInterface ability interface

type AppBuilder

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

AppBuilder app builder

func NewAppBuilder

func NewAppBuilder(appCode string) *AppBuilder

NewAppBuilder new a custom app builder

func (*AppBuilder) Build

func (b *AppBuilder) Build()

func (*AppBuilder) WithDB

func (b *AppBuilder) WithDB(db *gorm.DB) *AppBuilder

func (*AppBuilder) WithNC

func (b *AppBuilder) WithNC(nc *nats.Conn) *AppBuilder

func (*AppBuilder) WithWebServer

func (b *AppBuilder) WithWebServer() *AppBuilder

type AppStruct

type AppStruct struct {
	AppCode string   // app code
	Ability *Ability // app ability
	// contains filtered or unexported fields
}

var App *AppStruct

func NewApp

func NewApp() *AppStruct

NewApp new standard app

func (*AppStruct) Destroy

func (a *AppStruct) Destroy()

func (*AppStruct) GetAPIBuilder

func (a *AppStruct) GetAPIBuilder() *router.APIBuilder

GetAPIBuilder get web server api builder

func (*AppStruct) GetIcon

func (a *AppStruct) GetIcon(ctx iris.Context)

GetIcon get app icon file

func (*AppStruct) InitAbility

func (a *AppStruct) InitAbility()

InitAbility init ability

func (*AppStruct) StartWebServer

func (a *AppStruct) StartWebServer()

func (*AppStruct) WithAI

func (a *AppStruct) WithAI()

WithAI add AI support

func (*AppStruct) WithFFmpeg

func (a *AppStruct) WithFFmpeg()

WithFFmpeg add ffmpeg support

func (*AppStruct) WithFS

func (a *AppStruct) WithFS()

WithFS add fs support

func (*AppStruct) WithFileEventMonitor

func (a *AppStruct) WithFileEventMonitor(preferOps ...sdkdto.PreferOptions)

WithFileEventMonitor add file event monitor support

func (*AppStruct) WithKV

func (a *AppStruct) WithKV()

WithKV add kv support

func (*AppStruct) WithMessage

func (a *AppStruct) WithMessage()

WithMessage add message support

func (*AppStruct) WithMigrator

func (a *AppStruct) WithMigrator(migrator ability.IMigrator)

WithMigrator add migrator

func (*AppStruct) WithSchedule

func (a *AppStruct) WithSchedule()

WithSchedule add schedule support

type ModelMigrator

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

ModelMigrator migrate schema according to the model

func NewModelMigrator

func NewModelMigrator(models ...any) *ModelMigrator

func (*ModelMigrator) Migrate

func (m *ModelMigrator) Migrate(ugn *utils.UserGroupNamespace) error