elastic-builder - npm Package Compare versions

Comparing version 2.18.1 to 2.19.0

package.json

 {
   "name": "elastic-builder",
-  "version": "2.18.1",
+  "version": "2.19.0",
   "description": "A JavaScript implementation of the elasticsearch Query DSL",
@@ -5,0 +5,0 @@ "main": "src/index.js",

src/aggregations/bucket-aggregations/histogram-aggregation-base.js

@@ -171,2 +171,28 @@ 'use strict';
     /**
+     * Set's the range/bounds for the histogram aggregation.
+     * Useful when you want to limit the range of buckets in the histogram.
+     * It is particularly useful in the case of open data ranges that can result in a very large number of buckets.
+     * NOTE: Only available in Elasticsearch v7.10.0+
+     *
+     * @example
+     * const agg = esb.histogramAggregation('prices', 'price', 50).hardBounds(0, 500);
+     *
+     * @param {number|string} min Start bound / minimum bound value
+     * For histogram aggregation, Integer value can be used.
+     * For Date histogram, date expression can be used.
+     * Available expressions for interval:
+     * year, quarter, month, week, day, hour, minute, second
+     * @param {number|string} max End bound / maximum bound value
+     * For histogram aggregation, Integer value can be used.
+     * For Date histogram, date expression can be used.
+     * Available expressions for interval:
+     * year, quarter, month, week, day, hour, minute, second
+     * @returns {HistogramAggregationBase} returns `this` so that calls can be chained
+     */
+    hardBounds(min, max) {
+        this._aggsDef.hard_bounds = { min, max };
+        return this;
+    }
+
+    /**
      * Sets the missing parameter which defines how documents
@@ -173,0 +199,0 @@ * that are missing a value should be treated.

No alert changes

Improved metrics

Total package byte prevSize

1011478

increased by0.24%

Lines of code

25387

increased by0.19%

No dependency changes