habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More docs changes

Browse Source
This commit is contained in:
Josh Mock
2024-12-04 13:59:24 -06:00
parent 1fde515fcf
commit eef143073c
601 changed files with 21926 additions and 34500 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/reference/search.asciidoc
View File

@ -1,4 +1,5 @@
[[reference-search]]
== client.search
////////
===========================================================================================================================
@ -32,18 +33,20 @@
</style>
++++
[discrete]
[[client.search]]
== client.search
== `client.search()`
Run a search. Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.
{ref}/search-search.html[{es} documentation]
[discrete]
== Function signature
=== Function signature
[source,ts]
----
(SearchRequest, options?): Promise<SearchResponse>
(request: SearchRequest, options?: TransportRequestOptions) => Promise<SearchResponse>
----
[discrete]
@ -124,6 +127,7 @@ interface SearchRequest extends <<RequestBase>> {
----
[discrete]
=== Response
@ -133,3 +137,4 @@ type SearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>
----