@humanwhocodes/momoa - npm Package Compare versions

Comparing version 3.3.5 to 3.3.6

dist/momoa.d.ts

@@ -0,1 +1,6 @@
+/**
+ * @fileoverview Type definitions for the Momoa JSON parser.
+ * @author Nicholas C. Zakas
+ */
+
 //-----------------------------------------------------------------------------
@@ -33,3 +38,3 @@ // Options
      */
-    readonly mode: Mode$1;
+    readonly mode?: Mode$1;
 
@@ -39,3 +44,3 @@ /**
      */
-    readonly ranges: boolean;
+    readonly ranges?: boolean;
 }
@@ -51,3 +56,3 @@
      */
-    readonly mode: Mode$1;
+    readonly mode?: Mode$1;
 
@@ -57,3 +62,3 @@ /**
      */
-    readonly ranges: boolean;
+    readonly ranges?: boolean;
 
@@ -64,3 +69,3 @@ /**
      */
-    readonly tokens: boolean;
+    readonly tokens?: boolean;
 
@@ -305,2 +310,6 @@ /**
 type TraversalPhase = TraversalPhase$1;
+type TraversalVisitor = {
+    enter?: (node: Node, parent?: Node) => void;
+    exit?: (node: Node, parent?: Node) => void;
+};
 /**
@@ -359,12 +368,12 @@ * @fileoverview Evaluator for Momoa AST.
  * @param {string} text The source text to tokenize.
- * @param {TokenizeOptions} options Options for doing the tokenization.
+ * @param {TokenizeOptions} [options] Options for doing the tokenization.
  * @returns {Array<Token>} An iterator over the tokens.
  */
-declare function tokenize(text: string, options: TokenizeOptions): Array<Token>;
+declare function tokenize(text: string, options?: TokenizeOptions): Array<Token>;
 /**
  * Traverses an AST from the given node.
  * @param {Node} root The node to traverse from
- * @param {Object} visitor An object with an `enter` and `exit` method.
+ * @param {TraversalVisitor} visitor An object with an `enter` and `exit` method.
  */
-declare function traverse(root: Node, visitor: any): void;
+declare function traverse(root: Node, visitor: TraversalVisitor): void;
 declare namespace types {
@@ -462,5 +471,10 @@ /**
 /** @typedef {import("./typedefs.ts").TraversalPhase} TraversalPhase */
+/**
+ * @typedef {Object} TraversalVisitor
+ * @property {(node: Node, parent?: Node) => void} [enter]
+ * @property {(node: Node, parent?: Node) => void} [exit]
+ */
 declare const childKeys: Map<string, string[]>;
 
-export { type AnyNode, type ArrayNode, type BooleanNode, type DocumentNode, type ElementNode, type FilterPredicate, type IdentifierNode, type InfinityNode, type JSONValue, type Location, type MemberNode, type Mode, type NaNNode, type Node, type NodeParts, type NullNode, type NumberNode, type ObjectNode, type ParseOptions, type Range, type Sign, type StringNode, type Token, type TokenType, type TokenizeOptions, type TraversalPhase, type ValueNode, evaluate, iterator, parse, print, tokenize, traverse, types, childKeys as visitorKeys };
+export { type AnyNode, type ArrayNode, type BooleanNode, type DocumentNode, type ElementNode, type FilterPredicate, type IdentifierNode, type InfinityNode, type JSONValue, type Location, type MemberNode, type Mode, type NaNNode, type Node, type NodeParts, type NullNode, type NumberNode, type ObjectNode, type ParseOptions, type Range, type Sign, type StringNode, type Token, type TokenType, type TokenizeOptions, type TraversalPhase, type TraversalVisitor, type ValueNode, evaluate, iterator, parse, print, tokenize, traverse, types, childKeys as visitorKeys };
 export type { ContainerNode, LocationRange };

package.json

 {
   "name": "@humanwhocodes/momoa",
-  "version": "3.3.5",
+  "version": "3.3.6",
   "description": "JSON AST parser, tokenizer, printer, traverser.",
@@ -36,3 +36,4 @@ "author": "Nicholas C. Zakas",
     "pretest": "npm run build",
-    "test": "mocha tests/**/*.js"
+    "test": "mocha tests/*.test.js && npm run test:types",
+    "test:types": "tsc --noEmit --project tests/types/tsconfig.json"
   },
@@ -63,4 +64,4 @@ "keywords": [
     "sinon": "^19.0.0",
-    "typescript": "^5.5.4"
+    "typescript": "^5.7.2"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

224740

0.62%

Lines of code

4916

0.51%

No dependency changes