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

added a warning about reusing config objects to the config docs and to the Client constructor

Browse Source
This commit is contained in:
Spencer Alger
2014-03-27 12:54:11 -07:00
parent 0f158381b3
commit db51f0ebaf
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/configuration.asciidoc
View File

@ -1,16 +1,19 @@
[[configuration]]
== Configuration
The `Client` constructor accepts a single object as it's argument, and the following keys can be used to configure that client instance.
The `Client` constructor accepts a single object as it's argument. In the <<config-options>> section all of the available options/keys are listed.
[source,js]
------
var elasticsearch = require('elasticsearch');
var client = new elasticsearch.Client({
...
... config options ...
});
------
WARNING: Due to the complex nature of the configuration, the config object you pass in will be modified and can only be used to create one `Client` instance. Sorry for the inconvenience. Related Github issue: https://github.com/elasticsearch/elasticsearch-js/issues/33
[[config-options]]
=== Config options
[horizontal]
`host or hosts`[[config-hosts]]::