re2js 1.2.1 → 1.2.3

package/README.md

@@ -1,5 +1,5 @@
 # RE2JS is the JavaScript port of RE2, a regular expression engine that provides linear time matching
-[![Test/Build/Deploy](https://github.com/le0pard/re2js/actions/workflows/tests.yml/badge.svg)](https://github.com/le0pard/re2js/actions/workflows/tests.yml)
+[![Test/Build/Publish](https://github.com/le0pard/re2js/actions/workflows/ci.yml/badge.svg)](https://github.com/le0pard/re2js/actions/workflows/ci.yml)
 
 ## [Playground](https://re2js.leopard.in.ua/)
 

package/build/index.cjs.cjs

@@ -2,7 +2,7 @@
  * re2js
  * RE2JS is the JavaScript port of RE2, a regular expression engine that provides linear time matching
  *
- * @version v1.2.1
+ * @version v1.2.3
  * @author Alexey Vasiliev
  * @homepage https://github.com/le0pard/re2js#readme
  * @repository github:le0pard/re2js
@@ -844,6 +844,7 @@ class MatcherInput {
 }
 
 class RE2JSException extends Error {
+  /** @param {string} message */
   constructor(message) {
     super(message);
     this.name = 'RE2JSException';
@@ -854,6 +855,10 @@ class RE2JSException extends Error {
  * 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) {
@@ -862,12 +867,15 @@ class RE2JSSyntaxException extends RE2JSException {
     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;
@@ -875,6 +883,7 @@ class RE2JSSyntaxException extends RE2JSException {
 
   /**
    * Retrieves the erroneous regular-expression pattern.
+   * @returns {string|null}
    */
   getPattern() {
     return this.input;
@@ -885,6 +894,7 @@ class RE2JSSyntaxException extends RE2JSException {
  * An exception thrown by the compiler
  */
 class RE2JSCompileException extends RE2JSException {
+  /** @param {string} message */
   constructor(message) {
     super(message);
     this.name = 'RE2JSCompileException';
@@ -895,6 +905,7 @@ class RE2JSCompileException extends RE2JSException {
  * An exception thrown by using groups
  */
 class RE2JSGroupException extends RE2JSException {
+  /** @param {string} message */
   constructor(message) {
     super(message);
     this.name = 'RE2JSGroupException';
@@ -905,6 +916,7 @@ class RE2JSGroupException extends RE2JSException {
  * An exception thrown by flags
  */
 class RE2JSFlagsException extends RE2JSException {
+  /** @param {string} message */
   constructor(message) {
     super(message);
     this.name = 'RE2JSFlagsException';
@@ -966,10 +978,14 @@ class Matcher {
     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);
@@ -995,8 +1011,10 @@ class Matcher {
    */
   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;
@@ -1010,6 +1028,7 @@ class Matcher {
 
   /**
    * Resets the {@code Matcher} and changes the input.
+   * @param {Utf8MatcherInput|Utf16MatcherInput} input
    * @returns {Matcher} the {@code Matcher} itself, for chained method calls
    */
   resetMatcherInput(input) {
@@ -1152,7 +1171,7 @@ class Matcher {
    * 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
    */
@@ -6200,7 +6219,7 @@ class RE2JS {
   /**
    * 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;
@@ -6222,6 +6241,7 @@ class RE2JS {
   }
 }
 
+exports.Matcher = Matcher;
 exports.RE2JS = RE2JS;
 exports.RE2JSCompileException = RE2JSCompileException;
 exports.RE2JSException = RE2JSException;