package basefn

Import Path
	github.com/gookit/goutil/x/basefn (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d basefn.go
		Package basefn provide some no-dependents util functions
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type ErrFunc (func)
		ErrFunc type

		As Inputs Of (at least 2)
			func CallOn(cond bool, fn ErrFunc) error
			func CallOrElse(cond bool, okFn, elseFn ErrFunc) error


Package-Level Functions (total 13)

	 func CallOn(cond bool, fn ErrFunc) error
		CallOn call func on condition is true

	 func CallOrElse(cond bool, okFn, elseFn ErrFunc) error
		CallOrElse call okFunc() on condition is true, else call elseFn()

	 func ErrOnFail(cond bool, err error) error
		ErrOnFail return input error on cond is false, otherwise return nil

	 func FirstOr[T](sl []T, elseVal T) T

		Type Parameters:
			T: any

		FirstOr get first elem or elseVal

	 func Must[T](v T, err error) T

		Type Parameters:
			T: any

		Must return like (v, error). will panic on error, otherwise return v.
		
		Usage:
		
			// old
			v, err := fn()
			if err != nil {
				panic(err)
			}
		
			// new
			v := goutil.Must(fn())

	 func MustIgnore(_ any, err error)
		MustIgnore for return like (v, error). Ignore return v and will panic on error.
		
		Useful for io, file operation func: (n int, err error)
		
		Usage:
		
			// old
			_, err := fn()
			if err != nil {
				panic(err)
			}
		
			// new
			basefn.MustIgnore(fn())

	 func MustOK(err error)
		MustOK if error is not empty, will panic

	 func OrError(cond bool, err error) error
		OrError return input error on cond is false, otherwise return nil

	 func OrReturn[T](cond bool, okFn, elseFn func() T) T

		Type Parameters:
			T: any

		OrReturn call okFunc() on condition is true, else call elseFn()
		
		like expr: if cond { okFunc() } else { elseFn() }

	 func OrValue[T](cond bool, okVal, elVal T) T

		Type Parameters:
			T: any

		OrValue get. like: if cond { okVal } else { elVal }

	 func PanicErr(err error)
		PanicErr panics if error is not empty

	 func Panicf(format string, v ...any)
		Panicf format panic message use fmt.Sprintf

	 func PanicIf(cond bool, fmtAndArgs ...any)
		PanicIf if cond = true, panics with an error message

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.