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

updated ssl/https docs

Browse Source
This commit is contained in:
Spencer Alger
2015-01-06 07:38:03 -07:00
parent 3e5df1b6ad
commit 3568fcbaef
4 changed files with 64 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api_conventions.asciidoc
View File

@ -21,6 +21,7 @@ NOTE: the https://github.com/fullscale/elastic.js[elastic.js] library can be use
* `requestTimeout` -- <<config-request-timeout, more info>>
* `maxRetries` -- <<config-max-retries, more info>>
[[api-conventions-cb]]
=== Callbacks or Promises
When a callback is passed to any of the API methods, it will be called with `(err, response, status)`. If you prefer to use promises, don't pass a callback and a promise will be returned. The promise will either be resolved with the response body, or rejected with the error that occured (including any 300+ response for non "exists" methods).