routevars

README

RouteVars

Easily get variables from any url.

Example

	var path = "/users/1234/john"
	var ok, vars = routevars.Match("/users/<<id:int>>/<<name:string>>", path)
	if ok {
		fmt.Println("Match!")
		for k, v := range vars {
			fmt.Printf("%s: %s\n", k, v)
		}
	} else {
		fmt.Println("No match")
	}

Installation

go get github.com/Nigel2392/routevars

Documentation

Index

• Constants
• func FormatURL(path string, v ...any) string
• func FormatURLSafe(path string, v ...any) (string, error)
• func Match(path, pathToMatch string) (bool, map[string]string)
• type URLFormatter
  • func (uf URLFormatter) Format(v ...any) string
  • func (uf URLFormatter) FormatSafe(v ...any) (string, error)
  • func (uf URLFormatter) Match(other string) (bool, map[string]string)

Constants

const (
	RT_PATH_VAR_PREFIX = "<<"
	RT_PATH_VAR_SUFFIX = ">>"
	RT_PATH_VAR_DELIM  = ":"
)

Router regex delimiters

const (
	NameInt      = "int"
	NameString   = "string"
	NameSlug     = "slug"
	NameUUID     = "uuid"
	NameAny      = "any"
	NameHex      = "hex"
	NameAlphaNum = "alphanum"
)

Router regex types.

const (
	// Match any character
	RT_PATH_REGEX_ANY = ".+"
	// Match any number
	RT_PATH_REGEX_NUM = "[0-9]+"
	// Match any string
	RT_PATH_REGEX_STR = "[a-zA-Z]+"
	// Match any hex number
	RT_PATH_REGEX_HEX = "[0-9a-fA-F]+"
	// Match any UUID
	RT_PATH_REGEX_UUID = "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
	// Match any alphanumeric string
	RT_PATH_REGEX_ALPHANUMERIC = "[0-9a-zA-Z_-]+"
	// Match any slug
	RT_PATH_REGEX_SLUG = "[0-9a-zA-Z_-]+"
)

Router regex patterns

Functions

func FormatURL

func FormatURL(path string, v ...any) string

func FormatURLSafe

func FormatURLSafe(path string, v ...any) (string, error)

func Match

func Match(path, pathToMatch string) (bool, map[string]string)

Types

type URLFormatter

type URLFormatter string

func (URLFormatter) Format

func (uf URLFormatter) Format(v ...any) string

Format the URL with the given arguments.

func (URLFormatter) FormatSafe

func (uf URLFormatter) FormatSafe(v ...any) (string, error)

Format the URL with the given arguments.

func (URLFormatter) Match

func (uf URLFormatter) Match(other string) (bool, map[string]string)

Match the URL with another URL.