- Enhancement: jsdoc/typescript type for better clarity and specificty

Author: brettz9

src/jsonpath.d.ts

@@ -3,22 +3,24 @@
  */
 declare module 'jsonpath-plus' {
   type JSONPathCallback = (
-      payload: any, payloadType: any, fullPayload: any
-  ) => any
+      payload: any, payloadType: "value"|"property", fullPayload: any
+  ) => void
 
-  type JSONPathOtherTypeCallback = (...args: any[]) => void
+  type JSONPathOtherTypeCallback = (...args: any[]) => boolean
+
+  type JSON = null|boolean|number|string|{[key: string]: JSON}|JSON[]
 
   interface JSONPathOptions {
     /**
      * The JSONPath expression as a (normalized or unnormalized) string or
      *   array.
      */
-    path: string | any[]
+    path?: string | string[]
     /**
      * The JSON object to evaluate (whether of null, boolean, number,
      *   string, object, or array type).
      */
-    json: null | boolean | number | string | object | any[]
+    json?: JSON|any
     /**
      * If this is supplied as false, one may call the evaluate method
      *  manually.
@@ -54,7 +56,7 @@ declare module 'jsonpath-plus' {
      * (Note that the current path and value will also be available to those
      *   expressions; see the Syntax section for details.)
      */
-    sandbox?: Map<string, any>
+    sandbox?: { [k: string]: any }
     /**
      * Whether or not to wrap the results in an array.
      *
@@ -95,7 +97,7 @@ declare module 'jsonpath-plus' {
      *
      * @default null
      */
-    parentProperty?: null | any
+    parentProperty?: null | string
     /**
      * If supplied, a callback will be called immediately upon retrieval of
      * an end point value.
@@ -146,7 +148,9 @@ declare module 'jsonpath-plus' {
      * Exposes the cache object for those who wish to preserve and reuse
      *   it for optimization purposes.
      */
-    cache: any
+    cache: {
+        [key: string]: string[]
+    }
 
     /**
      * Accepts a normalized or unnormalized path as string and
@@ -174,20 +178,15 @@ declare module 'jsonpath-plus' {
      * The JSONPath terminal constructions `~` and `^` and type operators
      *   like `@string()` are silently stripped.
      */
-    toPointer(path: string[]): any
+    toPointer(path: string[]): string
 
     evaluate(
         path: JSONPathOptions['path'],
         json: JSONPathOptions['json'],
         callback: JSONPathOptions['callback'],
         otherTypeCallback: JSONPathOptions['otherTypeCallback']
     ): any
-    evaluate(options: {
-        path: JSONPathOptions['path'],
-        json: JSONPathOptions['json'],
-        callback: JSONPathOptions['callback'],
-        otherTypeCallback: JSONPathOptions['otherTypeCallback']
-    }): any
+    evaluate(options?: JSONPathOptions): any
   }
 
   type JSONPathType = JSONPathCallable & JSONPathClass

src/jsonpath.js

@@ -1,7 +1,7 @@
 const {hasOwnProperty: hasOwnProp} = Object.prototype;
 
 /**
-* @typedef {null|boolean|number|string|PlainObject|GenericArray} JSONObject
+* @typedef {null|boolean|number|string|object<string, JSON>|JSON[]} JSON
 */
 
 /**
@@ -49,7 +49,7 @@ class NewError extends Error {
 /**
 * @typedef {PlainObject} ReturnObject
 * @property {string} path
-* @property {JSONObject} value
+* @property {JSON} value
 * @property {PlainObject|GenericArray} parent
 * @property {string} parentProperty
 */
@@ -64,7 +64,7 @@ class NewError extends Error {
 
 /**
 * @callback OtherTypeCallback
-* @param {JSONObject} val
+* @param {JSON} val
 * @param {string} path
 * @param {PlainObject|GenericArray} parent
 * @param {string} parentPropName
@@ -287,7 +287,7 @@ JSONPath.prototype._handleCallback = function (fullRetObj, callback, type) {
 /**
  *
  * @param {string} expr
- * @param {JSONObject} val
+ * @param {JSON} val
  * @param {string} path
  * @param {PlainObject|GenericArray} parent
  * @param {string} parentPropName