Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Format determins the output. It can be either JSON or CSV.
Format gnfmt.Format
// PreferredOnly hides BestResult if the user wants to see only
// preferred results.
PreferredOnly bool
// DataSources are IDs of DataSources that are important for
// user. Normally only one "the best" reusult returns. If user gives
// preferred sources, then matches from these sources are also
// returned.
DataSources []int
// WithAllMatches flag; if true, results include all matches per source,
// not only the best match.
WithAllMatches bool
// WithCapitalization flag; if true, the first rune of the name-string
// will be capitalized when appropriate.
WithCapitalization bool
// VerifierURL URL for gnames verification service. It only needs to
// be changed if user sets local version of gnames.
VerifierURL string
// Jobs is the number of verification jobs to run in parallel.
Jobs int
// Batch is the size of the string slices fed into input channel for
// verification.
Batch int
// NamesNumThreshold the number of names after which POST gets redirected
// to GET.
NamesNumThreshold int
}
Config collects and stores external configuration data.
type Option ¶
type Option func(cnf *Config)
Option is a type of all options for Config.
func OptDataSources ¶
OptDataSources set list of preferred sources.
func OptNamesNumThreshold ¶
OptNamesNumThreshold sets number of names after which there is no redirect from POST to GET.
func OptPreferredOnly ¶
OptPreferredOnly sets PreferredOnly field. If it is true output only contains results from preferred data-sources.
func OptVerifierURL ¶
OptVerifierURL sets URL of the verification resource.
func OptWithAllMatches ¶
OptWithAllMatches sets WithAllMatches flag.
func OptWithCapitalization ¶
OptWithCapitalization sets WithCapitalization field.
Click to show internal directories.
Click to hide internal directories.