re2js 1.2.2 → 1.2.3

package/build/index.umd.js

@@ -2,7 +2,7 @@
  * re2js
  * RE2JS is the JavaScript port of RE2, a regular expression engine that provides linear time matching
  *
- * @version v1.2.2
+ * @version v1.2.3
  * @author Alexey Vasiliev
  * @homepage https://github.com/le0pard/re2js#readme
  * @repository github:le0pard/re2js
@@ -848,6 +848,7 @@
   }
 
   class RE2JSException extends Error {
+    /** @param {string} message */
     constructor(message) {
       super(message);
       this.name = 'RE2JSException';
@@ -858,6 +859,10 @@
    * An exception thrown by the parser if the pattern was invalid.
    */
   class RE2JSSyntaxException extends RE2JSException {
+    /**
+     * @param {string} error
+     * @param {string|null} [input=null]
+     */
     constructor(error, input = null) {
       let message = `error parsing regexp: ${error}`;
       if (input) {
@@ -866,12 +871,15 @@
       super(message);
       this.name = 'RE2JSSyntaxException';
       this.message = message;
+      /** @type {string} */
       this.error = error;
+      /** @type {string|null} */
       this.input = input;
     }
 
     /**
      * Retrieves the description of the error.
+     * @returns {string}
      */
     getDescription() {
       return this.error;
@@ -879,6 +887,7 @@
 
     /**
      * Retrieves the erroneous regular-expression pattern.
+     * @returns {string|null}
      */
     getPattern() {
       return this.input;
@@ -889,6 +898,7 @@
    * An exception thrown by the compiler
    */
   class RE2JSCompileException extends RE2JSException {
+    /** @param {string} message */
     constructor(message) {
       super(message);
       this.name = 'RE2JSCompileException';
@@ -899,6 +909,7 @@
    * An exception thrown by using groups
    */
   class RE2JSGroupException extends RE2JSException {
+    /** @param {string} message */
     constructor(message) {
       super(message);
       this.name = 'RE2JSGroupException';
@@ -909,6 +920,7 @@
    * An exception thrown by flags
    */
   class RE2JSFlagsException extends RE2JSException {
+    /** @param {string} message */
     constructor(message) {
       super(message);
       this.name = 'RE2JSFlagsException';
@@ -970,10 +982,14 @@
       this.patternInput = pattern;
       const re2 = this.patternInput.re2();
       // The number of submatches (groups) in the pattern.
+      /** @type {number} */
       this.patternGroupCount = re2.numberOfCapturingGroups();
       // The group indexes, in [start, end) pairs.  Zeroth pair is overall match.
+      /** @type {number[]} */
       this.groups = [];
+      /** @type {Record<string, number>} */
       this.namedGroups = re2.namedGroups;
+      /** @type {number} */
       this.numberOfInstructions = re2.numberOfInstructions();
       if (input instanceof MatcherInputBase) {
         this.resetMatcherInput(input);
@@ -999,8 +1015,10 @@
      */
     reset() {
       // The input length in UTF16 codes.
+      /** @type {number} */
       this.matcherInputLength = this.matcherInput.length();
       // The append position: where the next append should start.
+      /** @type {number} */
       this.appendPos = 0;
       // Is there a current match?
       this.hasMatch = false;
@@ -1014,6 +1032,7 @@
 
     /**
      * Resets the {@code Matcher} and changes the input.
+     * @param {Utf8MatcherInput|Utf16MatcherInput} input
      * @returns {Matcher} the {@code Matcher} itself, for chained method calls
      */
     resetMatcherInput(input) {
@@ -1156,7 +1175,7 @@
      * Matches the input against the pattern (unanchored), starting at a specified position. If there
      * is a match, {@code find} sets the match state to describe it.
      *
-     * @param {string|number} [start=null] the input position where the search begins
+     * @param {number} [start=null] the input position where the search begins
      * @returns {boolean} if it finds a match
      * @throws IndexOutOfBoundsException if start is not a valid input position
      */
@@ -6204,7 +6223,7 @@
     /**
      * Return a map of the capturing groups in this matcher's pattern, where key is the name and value
      * is the index of the group in the pattern.
-     * @returns {*}
+     * @returns {Record<string, number>}
      */
     namedGroups() {
       return this.re2Input.namedGroups;
@@ -6226,6 +6245,7 @@
     }
   }
 
+  exports.Matcher = Matcher;
   exports.RE2JS = RE2JS;
   exports.RE2JSCompileException = RE2JSCompileException;
   exports.RE2JSException = RE2JSException;