Fix typo and add missing type (#178)

* Fix typo * Add missing about assertion * Update lib/index.d.ts Co-authored-by: Jonas Pauthier <[email protected]> Co-authored-by: Jonas Pauthier <[email protected]>
hapijs · Nov 29, 2022 · b4ffcec · b4ffcec
1 parent aa1f2b3
commit b4ffcec
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -504,6 +504,16 @@ declare namespace expect {
          */
         above(value: T): Assertion<T>;
 
+        /**
+         * Asserts that the reference value is within a delta difference from the provided value.
+         * 
+         * @param value - the value to compare to.
+         * @param delta - the delta +/- range value.
+         *
+         * @returns assertion chain object.
+         */
+        about(value: T, delta: number): Assertion<T>;
+
         /**
          * Asserts that the reference value is greater than (>) the provided value.
          *

diff --git a/lib/index.js b/lib/index.js
@@ -356,15 +356,15 @@ internals.between = function (from, to) {
 internals.addMethod('between', internals.between);
 
 
-internals.above = function (value, delta) {
+internals.about = function (value, delta) {
 
     internals.assert(this, internals.type(this._ref) === 'number', 'Can only assert about on numbers');
     internals.assert(this, internals.type(value) === 'number' && internals.type(delta) === 'number', 'About assertion requires two number arguments');
 
     return this.assert(Math.abs(this._ref - value) <= delta, 'be about ' + value + ' \u00b1' + delta);
 };
 
-internals.addMethod('about', internals.above);
+internals.addMethod('about', internals.about);
 
 
 internals.instanceof = function (type) {