Dart client library for accessing the HTTP API of Typesense search engine.
Note: This package is still under development. Some existing APIs might change or new APIs might be available in the future.
typesense as a dependency in your pubspec.yaml file.
dependencies: typesense: ^0.2.0
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.
The examples that walk you through on how to use the client: main.dart
Make sure to README beforehand.
|>= v0.21.0||>= v0.1.1|
This library is authored and maintained by our awesome community of contributors: