xevion/r2park
1
0
Fork 0
mirror of https://github.com/Xevion/r2park.git synced 2025-12-17 00:12:53 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add docs to helper functions

Browse Source
This commit is contained in:
Xevion
2023-12-12 01:46:50 -06:00
parent 2e7460e658
commit bd461217a0
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
helpers.go
View File

@@ -44,6 +44,8 @@ func BuildRequest(method string, path string, params map[string]string) *http.Re
return BuildRequestWithBody(method, path, params, nil) return BuildRequestWithBody(method, path, params, nil)
} }
// Plural returns an empty string if n is 1, otherwise it returns an "s".
// This is useful for pluralizing words in a sentence.
func Plural(n int) string { func Plural(n int) string {
if n == 1 { if n == 1 {
return "" return ""
@@ -75,6 +77,9 @@ func SetTypicalHeaders(req *http.Request, contentType *string, referrer *string,
} }
} }
// GetRandomItems returns N random items from the given array.
// The seed_value is used to control the output.
// If the array is not a slice, an error is returned.
func GetRandomItems[T any](arr []T, N int, seed_value int64) ([]T, error) { func GetRandomItems[T any](arr []T, N int, seed_value int64) ([]T, error) {
randgen := rand.New(rand.NewSource(seed_value)) randgen := rand.New(rand.NewSource(seed_value))
arrValue := reflect.ValueOf(arr) arrValue := reflect.ValueOf(arr)
@@ -103,6 +108,10 @@ func GetRandomItems[T any](arr []T, N int, seed_value int64) ([]T, error) {
return selectedItems, nil return selectedItems, nil
} }
// FilterLocations filters the given locations by the given query.
// If the query is empty, the locations are randomized. A seed value is used to control this output.
// If the query is not empty, the locations are filtered by the query.
// The limit parameter controls the maximum number of locations to return in all cases.
func FilterLocations(all_locations []Location, query string, limit int, seed_value int64) []Location { func FilterLocations(all_locations []Location, query string, limit int, seed_value int64) []Location {
if len(query) == 0 { if len(query) == 0 {
randomized, err := GetRandomItems(all_locations, limit, seed_value) randomized, err := GetRandomItems(all_locations, limit, seed_value)