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

moved the API info from README.md into api.md, and added a check for methods that have no params.

Browse Source 
[ci skip]
This commit is contained in:
Spencer Alger
2013-11-12 10:06:56 -07:00
parent 77a73d22c2
commit 2a2e4b9bee
5 changed files with 123 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -190,27 +190,7 @@ This function will receive a list of nodes received during a sniff. The list of
To maintain consistency across all the low-level clients ([PHP](https://github.com/elasticsearch/elasticsearch-php), [Python](https://github.com/elasticsearch/elasticsearch-ph), [Ruby](https://github.com/elasticsearch/elasticsearch-ruby), [Perl](https://github.com/elasticsearch/elasticsearch-perl)) all API methods accept an object with parameters and a callback. If you don't pass the callback, the functions will return a promise.
### Generic Params
Several parameters work on all API methods, and control the way that those requests are carried out:
### ignore
Type: `Number` or `Number[]`
Default: `null`
Don't treat these HTTP status codes as "errors". Example use cases could be `ignore: 404` or `ignore: [404]`
### timeout
Type: `Number`
Default: `client.config.timeout`
The number of milliseconds this request has to complete. It defaults to the timeout specified at the client level, which defaults to 10 seconds.
### Methods
All the methods can be seen [here](docs/api.md), or take a look at [api.js](src/lib/api.js).
For full details on the API, check out [api.md](docs/api.md).
### Examples