re2js 0.3.1 → 0.3.2

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 v0.3.1
+ * @version v0.3.2
  * @author Alexey Vasiliev
  * @homepage https://github.com/le0pard/re2js#readme
  * @repository github:le0pard/re2js
@@ -698,9 +698,19 @@ class MatcherInputBase {
   getEncoding() {
     throw Error('not implemented');
   }
+
+  /**
+   *
+   * @returns {boolean}
+   */
   isUTF8Encoding() {
     return this.getEncoding() === MatcherInputBase.Encoding.UTF_8;
   }
+
+  /**
+   *
+   * @returns {boolean}
+   */
   isUTF16Encoding() {
     return this.getEncoding() === MatcherInputBase.Encoding.UTF_16;
   }
@@ -714,12 +724,26 @@ class Utf8MatcherInput extends MatcherInputBase {
   getEncoding() {
     return MatcherInputBase.Encoding.UTF_8;
   }
+  /**
+   *
+   * @returns {string}
+   */
   asCharSequence() {
     return Utils.utf8ByteArrayToString(this.bytes);
   }
+
+  /**
+   *
+   * @returns {number[]}
+   */
   asBytes() {
     return this.bytes;
   }
+
+  /**
+   *
+   * @returns {number}
+   */
   length() {
     return this.bytes.length;
   }
@@ -733,12 +757,27 @@ class Utf16MatcherInput extends MatcherInputBase {
   getEncoding() {
     return MatcherInputBase.Encoding.UTF_16;
   }
+
+  /**
+   *
+   * @returns {string}
+   */
   asCharSequence() {
     return this.charSequence;
   }
+
+  /**
+   *
+   * @returns {number[]}
+   */
   asBytes() {
     return this.charSequence.toString().split('').map(s => s.codePointAt(0));
   }
+
+  /**
+   *
+   * @returns {number}
+   */
   length() {
     return this.charSequence.length;
   }
@@ -746,6 +785,7 @@ class Utf16MatcherInput extends MatcherInputBase {
 class MatcherInput {
   /**
    * Return the MatcherInput for UTF_16 encoding.
+   * @returns {Utf16MatcherInput}
    */
   static utf16(charSequence) {
     return new Utf16MatcherInput(charSequence);
@@ -753,6 +793,7 @@ class MatcherInput {
 
   /**
    * Return the MatcherInput for UTF_8 encoding.
+   * @returns {Utf8MatcherInput}
    */
   static utf8(input) {
     if (Array.isArray(input)) {
@@ -859,7 +900,7 @@ class Matcher {
    * Quotes '\' and '$' in {@code s}, so that the returned string could be used in
    * {@link #appendReplacement} as a literal replacement of {@code s}.
    *
-   * @param {string} s the string to be quoted
+   * @param {string} str the string to be quoted
    * @returns {string} the quoted string
    */
   static quoteReplacement(str) {
@@ -874,6 +915,11 @@ class Matcher {
       return s;
     }).join('');
   }
+  /**
+   *
+   * @param {RE2JS} pattern
+   * @param {Utf8MatcherInput|Utf16MatcherInput|number[]|string} input
+   */
   constructor(pattern, input) {
     if (pattern === null) {
       throw new Error('pattern is null');
@@ -895,7 +941,10 @@ class Matcher {
     }
   }
 
-  /** Returns the {@code RE2JS} associated with this {@code Matcher}. */
+  /**
+   * Returns the {@code RE2JS} associated with this {@code Matcher}.
+   * @returns {RE2JS}
+   */
   pattern() {
     return this.patternInput;
   }
@@ -903,7 +952,7 @@ class Matcher {
   /**
    * Resets the {@code Matcher}, rewinding input and discarding any match information.
    *
-   * @returns the {@code Matcher} itself, for chained method calls
+   * @returns {Matcher} the {@code Matcher} itself, for chained method calls
    */
   reset() {
     // The input length in UTF16 codes.
@@ -922,7 +971,7 @@ class Matcher {
 
   /**
    * Resets the {@code Matcher} and changes the input.
-   * @returns the {@code Matcher} itself, for chained method calls
+   * @returns {Matcher} the {@code Matcher} itself, for chained method calls
    */
   resetMatcherInput(input) {
     if (input === null) {
@@ -936,7 +985,8 @@ class Matcher {
   /**
    * Returns the start of the named group of the most recent match, or -1 if the group was not
    * matched.
-   *
+   * @param {string|number} [group=0]
+   * @returns {string}
    */
   start() {
     let group = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
@@ -954,7 +1004,8 @@ class Matcher {
   /**
    * Returns the end of the named group of the most recent match, or -1 if the group was not
    * matched.
-   *
+   * @param {string|number} [group=0]
+   * @returns {string}
    */
   end() {
     let group = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
@@ -971,7 +1022,8 @@ class Matcher {
 
   /**
    * Returns the named group of the most recent match, or {@code null} if the group was not matched.
-   *
+   * @param {string|number} [group=0]
+   * @returns {string}
    */
   group() {
     let group = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
@@ -1050,7 +1102,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 start the input position where the search begins
+   * @param {string|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
    */
@@ -1133,9 +1185,10 @@ class Matcher {
    *
    * @param {string} replacement the replacement string
    * @param {boolean} [perlMode=false] activate perl/js mode (different behaviour for capture groups and special characters)
-   * @returns the {@code Matcher} itself, for chained method calls
+   * @returns {string}
    * @throws IllegalStateException if there was no most recent match
    * @throws IndexOutOfBoundsException if replacement refers to an invalid group
+   * @private
    */
   appendReplacement(replacement) {
     let perlMode = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
@@ -1153,6 +1206,7 @@ class Matcher {
   /**
    * @param {string} replacement - the replacement string
    * @returns {string}
+   * @private
    */
   appendReplacementInternal(replacement) {
     let res = '';
@@ -1218,6 +1272,7 @@ class Matcher {
   /**
    * @param {string} replacement - the replacement string
    * @returns {string}
+   * @private
    */
   appendReplacementInternalPerl(replacement) {
     let res = '';
@@ -3087,6 +3142,8 @@ class Parser {
   }
   /**
    * Parse regular expression pattern {@code pattern} with mode flags {@code flags}.
+   * @param {string} pattern
+   * @param {number} flags
    */
   static parse(pattern, flags) {
     return new Parser(pattern, flags).parseInternal();
@@ -5559,7 +5616,7 @@ class RE2JS {
   /**
    * Helper: create new RE2JS with given regex and flags. Flregex is the regex with flags applied.
    * @param {string} regex
-   * @param {number} flags
+   * @param {number} [flags=0]
    * @returns {RE2JS}
    */
   static compile(regex) {
@@ -5591,7 +5648,7 @@ class RE2JS {
    * Matches a string against a regular expression.
    *
    * @param {string} regex the regular expression
-   * @param {*} input the input
+   * @param {string|number[]} input the input
    * @returns {boolean} true if the regular expression matches the entire input
    * @throws RE2JSSyntaxException if the regular expression is malformed
    */
@@ -5599,7 +5656,10 @@ class RE2JS {
     return RE2JS.compile(regex).matcher(input).matches();
   }
 
-  // This is visible for testing.
+  /**
+   * This is visible for testing.
+   * @private
+   */
   static initTest(pattern, flags, re2) {
     if (pattern == null) {
       throw new Error('pattern is null');
@@ -5612,6 +5672,12 @@ class RE2JS {
     p.re2Input = re2;
     return p;
   }
+
+  /**
+   *
+   * @param {string} pattern
+   * @param {number} flags
+   */
   constructor(pattern, flags) {
     // The pattern string at construction time.
     this.patternInput = pattern;
@@ -5649,7 +5715,7 @@ class RE2JS {
   /**
    * Matches a string against a regular expression.
    *
-   * @param {*} input the input
+   * @param {string|number[]} input the input
    * @returns {boolean} true if the regular expression matches the entire input
    */
   matches(input) {
@@ -5659,7 +5725,7 @@ class RE2JS {
   /**
    * Creates a new {@code Matcher} matching the pattern against the input.
    *
-   * @param {*} input the input string
+   * @param {string|number[]} input the input string
    * @returns {Matcher}
    */
   matcher(input) {
@@ -5680,8 +5746,8 @@ class RE2JS {
    * of the input, possibly including additional matches of the pattern.
    *
    * @param {string} input the input string to be split
-   * @param {number} limit the limit
-   * @returns {java.lang.String[]} the split strings
+   * @param {number} [limit=0] the limit
+   * @returns {string[]} the split strings
    */
   split(input) {
     let limit = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
@@ -5731,6 +5797,11 @@ class RE2JS {
     }
     return result;
   }
+
+  /**
+   *
+   * @returns {string}
+   */
   toString() {
     return this.patternInput;
   }
@@ -5753,6 +5824,12 @@ class RE2JS {
   namedGroups() {
     return this.re2Input.namedGroups;
   }
+
+  /**
+   *
+   * @param {*} other
+   * @returns {boolean}
+   */
   equals(other) {
     if (this === other) {
       return true;