Typesensory

An Elixir client for Typesense, "An open source search engine for building delightful search experiences."

Generated with the lovely OpenAPI Generator from the Typesense OpenAPI spec.

Installation

The package can be installed by adding typesensory to your list of dependencies in mix.exs:

def deps do
  [
    {:typesensory, "~> 0.1.0"}
  ]
end

Versioning

Typesensory version	Typesense OpenAPI version
0.1.x	0.24.0

Documentation

The documentation, such as it is, is available on HexDocs.

Building

To install the required dependencies and build Typesensory, run:

mix do deps.get, compile

To build the documentation locally, run:

mix docs

Configuration

You can override the URL of your server (e.g. if you have a separate development and production server in your configuration files).

config :typesensory, base_url: "http://localhost"

Multiple clients for the same API with different URLs can be created passing different base_urls when calling Typesensory.Connection.new/1:

client = Typesensory.Connection.new(base_url: "http://localhost")

Contributing

If find any bugs, or have ideas for improvements, the best way to get involved is to open an issue or a PR. PRs to improve and extend the documentation are especially welcome.