Преглед изворни кода

docs(elasticsearch-plugin): Improve docs for mapSort

Closes #1301
Michael Bromley пре 3 година
родитељ
комит
b746f17a70
1 измењених фајлова са 3 додато и 0 уклоњено
  1. 3 0
      packages/elasticsearch-plugin/src/options.ts

+ 3 - 0
packages/elasticsearch-plugin/src/options.ts

@@ -564,6 +564,9 @@ export interface SearchConfig {
      * Allows extending the `sort` input of the elasticsearch body as covered in
      * [Elasticsearch sort docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)
      *
+     * The `sort` input parameter contains the ElasticSearchSortInput generated for the default sort parameters "name" and "price".
+     * If neither of those are applied it will be empty.
+     *
      * @example
      * ```TS
      * mapSort: (sort, input) => {