package
2.0.0
Repository: https://github.com/phihero/typesense-go-ex.git
Documentation: pkg.go.dev

# Packages

Package api provides primitives to interact with the openapi HTTP API.
Package mocks is a generated GoMock package.
Package test contains integration tests for the github.com/typesense/typesense-go/typesense package.

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
WithAPIClient sets low-level API client.
WithAPIKey sets the API token.
WithCircuitBreakerInterval sets the cyclic period of the closed state for CircuitBreaker to clear the internal Counts, described in gobreaker documentation.
WithCircuitBreakerMaxRequests sets the maximum number of requests allowed to pass through when the CircuitBreaker is half-open.
WithCircuitBreakerName sets the name of the CircuitBreaker.
WithCircuitBreakerOnStateChange sets the function that is called whenever the state of CircuitBreaker changes.
WithCircuitBreakerReadyToTrip sets the function that is called with a copy of Counts whenever a request fails in the closed state.
WithCircuitBreakerTimeout sets the period of the open state, after which the state of CircuitBreaker becomes half-open.
WithClientConfig allows to pass all configs at once.
WithConnectionTimeout sets the connection timeout of http client.
WithHealthcheckInterval sets the wait time for an unhealthy node to become healthy again.
WithNearestNode sets the Load Balanced endpoint.
WithNodes sets multiple hostnames to load balance reads & writes across all nodes.
WithNumRetries sets the number of retries per request.
WithRetryInterval sets the wait time between each retry.
WithServer sets the API server URL.

# Constants

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

# Structs

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

# Interfaces

AliasesInterface is a type for Aliases API operations.
AliasInterface is a type for Alias API operations.
No description provided by the author
CollectionInterface is a type for Collection API operations.
CollectionsInterface is a type for Collections API operations.
No description provided by the author
DocumentsInterface is a type for Documents API operations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OverrideInterface is a type for Search Override API operations.
OverridesInterface is a type for Search Overrides API operations.
No description provided by the author
No description provided by the author
SynonymInterface is a type for Search Synonym API operations.
SynonymsInterface is a type for Search Synonyms API operations.

# Type aliases

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