Jido.Action.Catalog.Hit (Jido Action v2.3.0)

Ranked search hit returned from an action catalog query.

Summary

t()

new(attrs)

Builds a catalog hit.

new!(attrs)

Same as new/1, but raises on error.

schema()

Returns the Zoi schema used to validate catalog hits.

@type t() :: %Jido.Action.Catalog.Hit{
  entry: any(),
  matches: map(),
  reason: nil | binary(),
  score: float()
}

@spec new(map() | keyword()) :: {:ok, t()} | {:error, Exception.t()}

Builds a catalog hit.

@spec new!(map() | keyword()) :: t() | no_return()

Same as new/1, but raises on error.

@spec schema() :: term()

Returns the Zoi schema used to validate catalog hits.