Add comment

This commit is contained in:
sairoutine 2018-12-07 19:07:37 +09:00
parent e6bbd22614
commit d5367b15f2

View File

@ -26,6 +26,7 @@ var (
disableColor = false disableColor = false
) )
// LoggerConfig defines the config for Logger middleware.
type LoggerConfig struct { type LoggerConfig struct {
// Optional. Default value is gin.DefaultLogFormatter // Optional. Default value is gin.DefaultLogFormatter
Formatter LogFormatter Formatter LogFormatter
@ -55,6 +56,7 @@ type LogFormatterParams struct {
IsTerm bool IsTerm bool
} }
// DefaultLogFormatter is the default log format function Logger middleware uses.
var DefaultLogFormatter = func(param LogFormatterParams) string { var DefaultLogFormatter = func(param LogFormatterParams) string {
var statusColor, methodColor, resetColor string var statusColor, methodColor, resetColor string
if param.IsTerm { if param.IsTerm {
@ -117,6 +119,7 @@ func LoggerWithWriter(out io.Writer, notlogged ...string) HandlerFunc {
}) })
} }
// LoggerWithConfig instance a Logger middleware with config.
func LoggerWithConfig(conf LoggerConfig) HandlerFunc { func LoggerWithConfig(conf LoggerConfig) HandlerFunc {
formatter := conf.Formatter formatter := conf.Formatter
if formatter == nil { if formatter == nil {