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

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/reference-clear_scroll.asciidoc Normal file
View File

@ -0,0 +1,63 @@
[[reference-clear_scroll]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.clearScroll
Clear a scrolling search. Clear the search context and results for a scrolling search.
{ref}/clear-scroll-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ClearScrollRequest, options?): Promise<ClearScrollResponse>
----
[discrete]
===== `ClearScrollRequest`
[source,ts]
----
interface ClearScrollRequest extends <<shared-type-request-base, RequestBase>> {
scroll_id?: <<shared-type-scroll-ids, ScrollIds>>
}
----
[discrete]
===== `ClearScrollResponse`
[source,ts]
----
interface ClearScrollResponse {
succeeded: boolean
num_freed: <<shared-type-integer, integer>>
}
----