Typesensory.Api.Health (Typesensory v0.1.0)

API calls for all endpoints tagged Health.

Link to this section Summary

Functions

Checks if Typesense server is ready to accept requests. Checks if Typesense server is ready to accept requests.

Link to this section Functions

Link to this function

health(connection, opts \\ [])

@spec health(
  Tesla.Env.client(),
  keyword()
) :: {:ok, Typesensory.Model.HealthStatus.t()} | {:error, Tesla.Env.t()}

Checks if Typesense server is ready to accept requests. Checks if Typesense server is ready to accept requests.

parameters

Parameters

  • connection (Typesensory.Connection): Connection to server
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, Typesensory.Model.HealthStatus.t} on success
  • {:error, Tesla.Env.t} on failure