ungo

README

ungo

Unlock the potential of your golang development journey with UnJS - where innovation meets simplicity, and possibilities become limitless.

Usage

package main

import (
	"flag"

	"github.com/xbmlz/ungo/cfg"
	"github.com/xbmlz/ungo/server"
)

var configFile = flag.String("c", "config.yaml", "config file path")

type Config struct {
	Server server.Config
}

func main() {
	flag.Parse()

	config := &Config{}
	cfg.MustLoad(*configFile, config)

	srv := server.MustNewHTTPServer(config.Server)
	srv.Run()
}

Documentation

Index

• func WithID(id string) func(application *App)
• func WithName(name string) func(application *App)
• func WithServer(servers ...server.Server) func(application *App)
• func WithSignals(signals []os.Signal) func(application *App)
• func WithVersion(version string) func(application *App)
• type App
  • func NewApp(opts ...Option) *App
  • func (app *App) Run(ctx context.Context) error
  • func (app *App) Stop() error
• type Option

Functions

func WithID

func WithID(id string) func(application *App)

WithID application add id

func WithName

func WithName(name string) func(application *App)

WithName application add name

func WithServer

func WithServer(servers ...server.Server) func(application *App)

WithServer application add server

func WithSignals

func WithSignals(signals []os.Signal) func(application *App)

WithSignals application add listen signals

func WithVersion

func WithVersion(version string) func(application *App)

WithVersion application add version

Types

type App

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

App is the main application struct.

func NewApp

func NewApp(opts ...Option) *App

func (*App) Run

func (app *App) Run(ctx context.Context) error

Run application run

func (*App) Stop

func (app *App) Stop() error

Stop application stop

type Option

type Option func(application *App)

Option is a function that can be passed to NewApp to modify the App's behavior.