feat: notNull function

Author: dreamorosi

packages/jmespath/src/functions/Functions.ts

@@ -62,8 +62,11 @@ class Functions {
   }
 
   /**
-   * Determine if the provided value is contained in the provided item.
-   * TODO: write docs for funcContains()
+   * Determine if the given value is contained in the provided array or string.
+   *
+   * @param haystack The array or string to check
+   * @param needle The value to check for
+   * @returns True if the value is in the array or string, false otherwise
    */
   @Functions.signature({
     argumentsSpecs: [['array', 'string'], ['any']],
@@ -128,6 +131,13 @@ class Functions {
     }
   }
 
+  /**
+   * Map the provided function over the provided array.
+   *
+   * @param expression The expression to map over the array
+   * @param args The array to map the expression over
+   * @returns The result of mapping the expression over the array
+   */
   @Functions.signature({
     argumentsSpecs: [['any'], ['array']],
   })
@@ -203,7 +213,7 @@ class Functions {
     argumentsSpecs: [[]],
     variadic: true,
   })
-  public funcNotNull(args: Array<JSONValue>): JSONValue | null {
+  public funcNotNull(...args: Array<JSONValue>): JSONValue | null {
     return args.find((arg) => !Object.is(arg, null)) || null;
   }
 

packages/jmespath/src/functions/typeChecking.ts

@@ -44,12 +44,21 @@ const typeCheck = (
 };
 
 /**
- * TODO: write docs for Functions.#typeCheckArgument()
+ * Type checks an argument against a list of types.
  *
  * Type checking at runtime involves checking the top level type,
  * and in the case of arrays, potentially checking the types of
  * the elements in the array.
  *
+ * If the list of types includes 'any', then the type check is a
+ * no-op.
+ *
+ * If the list of types includes more than one type, then the
+ * argument is checked against each type in the list. If the
+ * argument matches any of the types, then the type check
+ * passes. If the argument does not match any of the types, then
+ * a JMESPathTypeError is thrown.
+ *
  * @param arg
  * @param argumentSpec
  */

packages/jmespath/tests/unit/functions.test.ts

@@ -1479,7 +1479,7 @@ describe('Functions tests', () => {
     expect(() => search(expression, data)).toThrow(error);
   });
 
-  /* it.each([
+  it.each([
     {
       expression: 'not_null(unknown_key, str)',
       expected: 'Str',
@@ -1521,25 +1521,25 @@ describe('Functions tests', () => {
 
     // Assess
     expect(result).toStrictEqual(expected);
-  }); */
-  /* it.each([
+  });
+
+  it.each([
     {
       expression: 'not_null()',
       error:
-        'ArgumentError: not_null() takes at least 1 argument but received 0',
+        'Expected 1 argument for function not_null(), received 0 in expression: not_null()',
     },
   ])('not_null() function errors', ({ expression, error }) => {
-    // TODO: see if we can assert the error type as well in not_null() errors tests
     // Prepare
     const data = {
       type: 'object',
     };
 
     // Act & Assess
     expect(() => search(expression, data)).toThrow(error);
-  }); */
+  });
 
-  /* it.each([
+  it.each([
     {
       description: 'function projection on variadic function',
       expression: 'foo[].not_null(f, e, d, c, b, a)',
@@ -1580,7 +1580,7 @@ describe('Functions tests', () => {
       // Assess
       expect(result).toStrictEqual(expected);
     }
-  ); */
+  );
 
   /* it.each([
     {