client

Documentation

Index

• func ConfigCmd(defaultCLIHome string) *cobra.Command
• func Paginate(numObjs, page, limit, defLimit int) (start, end int)
• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)
• func ValidateCmd(cmd *cobra.Command, args []string) error

Functions

func ConfigCmd

func ConfigCmd(defaultCLIHome string) *cobra.Command

ConfigCmd returns a CLI command to interactively create an application CLI config file.

func Paginate

func Paginate(numObjs, page, limit, defLimit int) (start, end int)

Paginate returns the correct starting and ending index for a paginated query, given that client provides a desired page and limit of objects and the handler provides the total number of objects. The start page is assumed to be 1-indexed. If the start page is invalid, non-positive values are returned signaling the request is invalid; it returns non-positive values if limit is non-positive and defLimit is negative.

func RegisterRoutes

func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)

Register routes

func ValidateCmd

func ValidateCmd(cmd *cobra.Command, args []string) error

ValidateCmd returns unknown command error or Help display if help flag set