route

Documentation

Overview

Package route provides route-related convenience functions.

Index

• func FromPath(contentDir, path string) string
• func IsRoot(route string) bool
• func IsValid(route string) bool
• func ToSegments(route string) []string

Functions

func FromPath

func FromPath(contentDir, path string) string

FromPath converts a filepath to a valid verless route that can be registered in a route tree.

A filepath like `content/blog/making-barista-quality-espresso.md` will be converted to `/blog/making-barista-quality-espresso`, for example.

func IsRoot

func IsRoot(route string) bool

IsRoot indicates if a given route is the root route.

func IsValid

func IsValid(route string) bool

IsValid indicates whether a given route is valid or not.

func ToSegments

func ToSegments(route string) []string

ToSegments returns the individual segments for a route. Those segments represent the nodes for a route tree.