package
0.0.0-20231006183139-e08dff8f0a3f
Repository: https://github.com/darklabel91/api_names.git
Documentation: pkg.go.dev

# Functions

CreateRoot creates a user directly from the server.
GetAllNames returns all non-deleted names in the database.
GetAllUsers returns all users in the database.
GetNameById returns the name record with the given ID (non-deleted).
GetNameByName returns the name record with the given name (non-deleted).
GetSimilarMatch searches for a similar match for a given name in a slice of NameType.
GetUserByEmail gets a user by their email.
OrderBySimilarity sorts an array of NameSimilarity objects by descending similarity and then by ascending name length.
SearchCacheMetaphone searches for all NameType objects in the cache that have a matching metaphone value and returns them as a slice.
SearchCanonicalName searches for a canonical name in a list of names using a given threshold for similarity matching.
SearchSimilarMetaphone returns a slice of NameType elements that have a metaphone similar to the given paradigmMetaphone.
SearchSimilarNames returns a slice of NameLevenshtein elements that have a similarity score higher than the given threshold to the given paradigmName.
TrustedIPs returns all IPs from users on the database.

# Constants

No description provided by the author

# Variables

No description provided by the author
No description provided by the author

# Structs

Log is a struct representing a log record.
NameSimilarity contains a name and a Levenshtein score.
NameType is a struct representing a name record.
User is the struct for API users.
UserInputBody is the struct for validation middlewares.