search: discourage use of IndexableDocument in the frontend

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2022-03-17 16:00:26 +00:00
parent a6d402200d
commit d48122a439
1 changed files with 4 additions and 1 deletions
@@ -88,7 +88,10 @@ export interface SearchDocument {
 }

 /**
- * Properties related to indexing of documents.
+ * Properties related to indexing of documents. This type is only useful for
+ * backends working directly with documents being inserted or retrieved from
+ * search indexes. When dealing with documents in the frontend, use
+ * {@link SearchDocument}.
 * @beta
 */
 export type IndexableDocument = SearchDocument & {