Typesense pub package CircleCI codecov pub points

Dart client library for accessing the HTTP API of Typesense search engine.

Note: This package is still under development. Version 0.2.0 will be fully migrated to null safety; related issue. Some existing APIs might change or new APIs might be available in the future.

Installation

Add typesense as a dependency in your pubspec.yaml file.

dependencies:
  typesense: ^0.1.1

Usage

Read the documentation here: https://typesense.org/docs/api/

Tests are also a good place to know how the library works internally: test

Note: When using this library in a user-facing app, please be sure to use an API Key that only allows search operations instead of the master API key. See keys.dart for an example of how to generate a search only API key.

See Configuration class for a list of all client configuration options.

Examples

The examples that walk you through on how to use the client: main.dart

Make sure to README beforehand.

Contributing

Visit CONTRIBUTING.md

Libraries

typesense