IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« Errors
Elastic Docs ›elasticsearch.js

API Param Types

edit

API Param Types

edit

The 7.6 API describes the type that each parameter accepts, this reference describes each of those types in more a little more detail.

Boolean

 — true or false.

Number

 — A basic JavaScript number.

String

 — A basic JavaScript String.

String[]

 — An array of strings.

Object

 — A JSON serializable object.

Object[]

 — An array of JSON serializable objects.

JSON

 — A string or Buffer containing a serialized JSON object.

JSONLines

 — A string or Buffer of new-line (\n) delimited JSON objects.

DurationString

 — A string that represents a duration of time with a number followed by an elasticsearch time unit. 30m is thirty minutes, 2d is two days, and so on.

« Errors