github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/docs/development/core/server/kibana-plugin-server.callapioptions.md
Lukas Olson 6ca6b1ad92 Allow passing in a signal to abort a cluster client request (#37563) 
* Allow passing in a signal to abort an Elasticsearch request using the cluster client

* Go back to using promises (which still return abort method) and update test

* Update docs

* Explicitly return Promise<any> instead of {}
2019-06-12 15:46:13 -07:00

1.1 KiB
Raw Blame History

Home > kibana-plugin-server > CallAPIOptions

CallAPIOptions interface

The set of options that defines how API call should be made and result be processed.

Signature:

export interface CallAPIOptions

Properties

Property Type Description
signal AbortSignal A signal object that allows you to abort the request via an AbortController object.
wrap401Errors boolean Indicates whether 401 Unauthorized errors returned from the Elasticsearch API should be wrapped into Boom error instances with properly set WWW-Authenticate header that could have been returned by the API itself. If API didn't specify that then Basic realm="Authorization Required" is used as WWW-Authenticate.