Meili.Client (Meili v0.2.0)

Configuration client struct for interacting with Meilisearch.

Summary

t()

new(opts \\ [])

Performs an HTTP request using the client's Req.Request instance.

Same as request/4 but raises a Meili.Error on failure.

@type t() :: %Meili.Client{
  key: String.t() | nil,
  req: Req.Request.t(),
  url: String.t()
}

@spec new(Keyword.t() | map()) :: t()

:url or :endpoint - The Meilisearch base URL (default: http://localhost:7700).
:key or :api_key - The API key or master key for authentication.
:req_options - Custom configuration options passed directly to Req.new/1.

client = Meili.Client.new(url: "http://localhost:7700", key: "secret-key")

@spec request(t(), atom() | String.t(), String.t(), Keyword.t()) ::
  {:ok, term()} | {:error, Meili.Error.t()}

Performs an HTTP request using the client's Req.Request instance.

{:ok, body} = Meili.Client.request(client, :get, "/health")

@spec request!(t(), atom() | String.t(), String.t(), Keyword.t()) ::
  term() | no_return()

Same as request/4 but raises a Meili.Error on failure.

body = Meili.Client.request!(client, :get, "/health")