meilisearch_ex v1.1.2

View Source Meilisearch.Health (meilisearch_ex v1.1.2)

Retreive Meilisearch health status. Health API

Link to this section Summary

Types

t()

Functions

cast(data)
get(client)

Get a response from the /health endpoint of Meilisearch. Meilisearch documentation

healthy?(client)

Check the response from the /health endpoint of Meilisearch. Meilisearch documentation

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Meilisearch.Health{status: String.t()}

Link to this section Functions

Link to this function

cast(data)

View Source
Link to this function

get(client)

View Source 
@spec get(Tesla.Client.t()) :: {:ok, t()} | {:error, Meilisearch.Client.error()}

Get a response from the /health endpoint of Meilisearch. Meilisearch documentation

examples

 Examples 

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Health.get(client)
{:ok, %{status: "available"}}
Link to this function

healthy?(client)

View Source 
@spec healthy?(Tesla.Client.t()) :: boolean()

Check the response from the /health endpoint of Meilisearch. Meilisearch documentation

examples

 Examples 

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Health.healthy?(client)
true