search

meilisearch / meilisearch-dart

The Meilisearch API client written for Dart
https://meilisearch.com
MIT License
77 stars 26 forks source link

Add section about the new `MeiliDocumentContainer<T>` class in readme #356

Closed ahmednfwela closed 6 months ago

ahmednfwela commented 11 months ago

this PR https://github.com/meilisearch/meilisearch-dart/pull/350 added MeiliDocumentContainer<T> but its usage is optional. we need to document to users how to use it, and use it more in the code samples.

to opt-in for it, users need to call mapToContainer() extension methods on search results.

relevant test:

https://github.com/meilisearch/meilisearch-dart/blob/d1103654f4ca7e72c751700d963b0ccf6bfc1263/test/search_test.dart#L471-L500