parse

package

v1.0.2 Latest Latest Go to latest Published: Jun 1, 2025 License: MIT Imports: 7 Imported by: 0

Details

Package parse contains helper functions for parsing different kinds of URL and Query parameters.

This section is empty.

This section is empty.

func ArrayQueryParam[T any](
	r *http.Request,
	paramName string,
	defaultValue []T,
	parserFunc ParserFunc[T],
) ([]T, error)

ArrayQueryParam is used to parse an optional array parameter provided to a query. The format that should be used here is: ?paramName=1,2,3&...

func QueryParam[T any](
	r *http.Request,
	paramName string,
	defaultValue T,
	parserFunc ParserFunc[T],
) (T, error)

QueryParam is used to parse an optional parameter provided to a query.

func RequiredArrayQueryParam[T any](
	r *http.Request,
	paramName string,
	parserFunc ParserFunc[T],
) ([]T, error)

RequiredArrayQueryParam is used to parse a required array parameter provided to a query. The format that should be used here is: ?paramName=1,2,3&...

func RequiredQueryParam[T any](
	r *http.Request,
	paramName string,
	parserFunc ParserFunc[T],
) (T, error)

RequiredQueryParam is used to parse a required parameter provided to a query.

func String(_ string, _ string, value string) (string, error)

String is used to parse a parameter as string value. As all parameters are string by default this returns the original value.

func URLParam[T any](
	r *http.Request,
	paramName string,
	parserFunc ParserFunc[T],
) (T, error)

URLParam is used to parse a required parameter provided to a URL.

func UUID(paramType string, paramName string, value string) (string, error)

UUID is used to parse a parameter as UUID value. Technically this only validates if a string is a UUID.

type ParserFunc[T any] func(paramType string, paramName string, value string) (T, error)

ParserFunc is the expected format used for parsing data using any parsing function.

func Date(layout string) ParserFunc[time.Time]

Date parses a parameter as a date. The parameter should match the required date layout.

func Int(isPositive bool, isZero bool) ParserFunc[int]

Int parses a parameter as [int].

func Int64(isPositive bool, isZero bool) ParserFunc[int64]

Int64 parses a parameter as [int64].