Skip to content

Commit 96fc517

Browse files
author
exoego
committed
Correct document
1 parent 9297b43 commit 96fc517

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

src/aggregations/bucket-aggregations/composite-agg-values-sources/values-source-base.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,14 @@ class ValuesSourceBase {
106106
}
107107

108108
/**
109-
* Specifies to include documents without a value for a given source in the
110-
* response,or not. Defaults to `false` (not include.
109+
* Specifies whether to include documents without a value for a given source
110+
* in the response. Defaults to `false` (not included).
111+
*
112+
* Note: This method is incompatible with elasticsearch 5.6 and older.
113+
* Use it only with elasticsearch 6.0 and later.
111114
*
112115
* @param {boolean} value
116+
* @returns {ValuesSourceBase} returns `this` so that calls can be chained
113117
*/
114118
missingBucket(value) {
115119
this._opts.missing_bucket = value;

src/index.d.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4656,7 +4656,7 @@ declare namespace esb {
46564656
* in a document.
46574657
*
46584658
* Note: The `missing` option of the composite aggregation is deprecated in
4659-
* [Elastticsearch v6.0](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/breaking-changes-6.0.html#_literal_missing_literal_is_deprecated_in_the_literal_composite_literal_aggregation),
4659+
* [Elasticsearch v6.0](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/breaking-changes-6.0.html#_literal_missing_literal_is_deprecated_in_the_literal_composite_literal_aggregation),
46604660
* `missing_bucket` should be used instead.
46614661
*
46624662
* @param {string} value
@@ -4666,7 +4666,10 @@ declare namespace esb {
46664666
/**
46674667
* Specifies to include documents without a value for a given source in the
46684668
* response, or not. Defaults to `false` (not include).
4669-
*
4669+
*
4670+
* Note: This method is incompatible with elasticsearch 5.6 and older.
4671+
* Use it only with elasticsearch 6.0 and later.
4672+
*
46704673
* @param {boolean} value
46714674
*/
46724675
missingBucket(value: boolean): this;

0 commit comments

Comments
 (0)