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

[docs] add more detailed type information for parameters

Browse Source
This commit is contained in:
spalger
2016-11-16 18:12:41 -07:00
parent f3bf5e08d0
commit 9fee381c8e
4 changed files with 41 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/api_param_types.asciidoc Normal file
View File

@ -0,0 +1,23 @@
[[api-param-types]]
== API Param Types
The <<api-reference>> describes the type that each parameter accepts, this reference describes each of those types in more a little more detail.
[horizontal]
`Boolean`[[api-param-type-boolean]]:: -- `true` or `false`.
`Number`[[api-param-type-number]]:: -- A basic JavaScript number.
`String`[[api-param-type-string]]:: -- A basic JavaScript https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String[String].
`String[]`[[api-param-type-string-array]]:: -- An array of strings.
`Object`[[api-param-type-object]]:: -- A JSON serializable object.
`Object[]`[[api-param-type-object-array]]:: -- An array of JSON serializable objects.
`JSON`[[api-param-type-json]]:: -- A string or `Buffer` containing a serialized JSON object.
`JSONLines`[[api-param-type-json-lines]]:: -- A string or `Buffer` of new-line (`\n`) delimited JSON objects.
`DurationString`[[api-param-type-duration-string]]:: -- A string that represents a duration of time with a number followed by an https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units[elasticsearch time unit]. `30m` is thirty minutes, `2d` is two days, and so on.