flag

Documentation

Overview

Package flag need for convenient get object flag from lib cli.

Index

• func NewIntFlag(name, usage string, options ...OptionInt) *cli.IntFlag
• func NewStrFlag(name, usage string, options ...OptionString) *cli.StringFlag
• type OptionInt
  • func IntAliases(values ...string) OptionInt
  • func IntDefault(value int) OptionInt
  • func IntEnv(values ...string) OptionInt
  • func IntRequired() OptionInt
• type OptionString
  • func StrAliases(values ...string) OptionString
  • func StrDefault(value string) OptionString
  • func StrEnv(values ...string) OptionString
  • func StrRequired() OptionString

Functions

func NewIntFlag

func NewIntFlag(name, usage string, options ...OptionInt) *cli.IntFlag

NewIntFlag create new IntFlag by options.

func NewStrFlag

func NewStrFlag(name, usage string, options ...OptionString) *cli.StringFlag

NewStrFlag create new StringFlag by options.

Types

type OptionInt

type OptionInt func(f *cli.IntFlag)

OptionInt params for build int flag.

func IntAliases

func IntAliases(values ...string) OptionInt

IntAliases set aliases for IntFlag.

func IntDefault

func IntDefault(value int) OptionInt

IntDefault set default value for IntFlag.

func IntEnv

func IntEnv(values ...string) OptionInt

IntEnv set env name for IntEnv.

func IntRequired

func IntRequired() OptionInt

IntRequired set flag mandatory for IntFlag.

type OptionString

type OptionString func(f *cli.StringFlag)

OptionString params for build string flag.

func StrAliases

func StrAliases(values ...string) OptionString

StrAliases set aliases for StringFlag.

func StrDefault

func StrDefault(value string) OptionString

StrDefault set default value for StringFlag.

func StrEnv

func StrEnv(values ...string) OptionString

StrEnv set env name for StringFlag.

func StrRequired

func StrRequired() OptionString

StrRequired set flag mandatory for StringFlag.