package
0.0.0-20210926151154-c84f9946de21
Repository: https://github.com/southclaws/samp-servers-api.git
Documentation: pkg.go.dev

# Functions

AddressFromString validates an address field for a server and ensures it contains the correct combination of host:port with either "samp://" or an empty scheme.

# Constants

ByPlayers means the list will use the amount of players as a sort key.
FilterEmpty filters out empty servers.
FilterFull filters out full servers.
FilterPassword filters out servers with passwords.
PageSizeDefault controls the default page size of listings.
SortAsc is the ascending sort order for listings.
SortDesc is the descending sort order for listings.

# Structs

Config stores app global configuration.
Route represents an API route and its associated handler function.
Server contains all the information associated with a game server including the core information, the standard SA:MP "rules" and "players" lists as well as any additional fields to enhance the server browsing experience.
ServerCore stores the standard SA:MP 'info' query fields necessary for server lists.
ServerListParams represents the URL query parameters for server listing.
Statistics represents a set of simple metrics for the entire listing database.

# Interfaces

RouteHandler represents an version group of API endpoints.

# Type aliases

FilterAttribute represents a filter to apply to results.
PageSize represents a query page size parameter.
SortColumn represents a column to sort results by.
SortOrder represents a query result sort order.