[config/docs] move createNodeAgent section up

This commit is contained in:
spalger
2016-01-05 10:12:43 -07:00
parent 04dfa9deef
commit 809f545dee
2 changed files with 42 additions and 38 deletions

View File

@ -242,6 +242,27 @@ see https://github.com/elasticsearch/elasticsearch-js/blob/master/src/lib/nodes_
`createNodeAgent`[[config-create-node-agent]]:: `Function` -- Override the way that the client creates node.js `Agent`[https://nodejs.org/api/http.html#http_class_http_agent] objects. The value of this property will be executed every time a new Node is added to the client (either from the initial seed or from sniffing) and can return any value that node's http(s) module accepts as `agent:` configuration.
+
The function is called with two arguments, first an `HttpConnector`[http://github.com/spalger/elasticsearch-js/blob/master/src/lib/connectors/http.js] object and the second the config object initially passed when creating the client.
Default::: `HttpConnector#createAgent()`
Disable Agent creation:::
+
[source,js]
-----
var client = new elasticsearch.Client({
createNodeAgent: function () {
return false;
}
});
-----
=== Examples
Connect to just a single seed node, and use sniffing to find the rest of the cluster.
@ -343,22 +364,3 @@ var client = new elasticsearch.Client({
}
})
-----
`createNodeAgent`[[config-createNodeAgent]]:: `Function` -- Override the way that the client creates node.js `Agent`[https://nodejs.org/api/http.html#http_class_http_agent] objects. The value of this property will be executed every time a new Node is added to the client (either from the initial seed or from sniffing) and can return any value that node's http(s) module accepts as `agent:` configuration.
+
The function is called with two arguments, first an `HttpConnector`[http://github.com/spalger/elasticsearch-js/blob/master/src/lib/connectors/http.js] object and the second the config object initially passed when creating the client.
Default::: `HttpConnector#createAgent()`
Disable Agent creation:::
+
[source,js]
-----
var client = new elasticsearch.Client({
createNodeAgent: function () {
return false;
}
});
-----

View File

@ -233,6 +233,27 @@ see https://github.com/elasticsearch/elasticsearch-js/blob/master/src/lib/nodes_
`createNodeAgent`[[config-create-node-agent]]:: `Function` -- Override the way that the client creates node.js `Agent`[https://nodejs.org/api/http.html#http_class_http_agent] objects. The value of this property will be executed every time a new Node is added to the client (either from the initial seed or from sniffing) and can return any value that node's http(s) module accepts as `agent:` configuration.
+
The function is called with two arguments, first an `HttpConnector`[http://github.com/spalger/elasticsearch-js/blob/master/src/lib/connectors/http.js] object and the second the config object initially passed when creating the client.
Default::: `HttpConnector#createAgent()`
Disable Agent creation:::
+
[source,js]
-----
var client = new elasticsearch.Client({
createNodeAgent: function () {
return false;
}
});
-----
=== Examples
Connect to just a single seed node, and use sniffing to find the rest of the cluster.
@ -334,22 +355,3 @@ var client = new elasticsearch.Client({
}
})
-----
`createNodeAgent`[[config-createNodeAgent]]:: `Function` -- Override the way that the client creates node.js `Agent`[https://nodejs.org/api/http.html#http_class_http_agent] objects. The value of this property will be executed every time a new Node is added to the client (either from the initial seed or from sniffing) and can return any value that node's http(s) module accepts as `agent:` configuration.
+
The function is called with two arguments, first an `HttpConnector`[http://github.com/spalger/elasticsearch-js/blob/master/src/lib/connectors/http.js] object and the second the config object initially passed when creating the client.
Default::: `HttpConnector#createAgent()`
Disable Agent creation:::
+
[source,js]
-----
var client = new elasticsearch.Client({
createNodeAgent: function () {
return false;
}
});
-----