re2js 0.3.0 → 0.3.2

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 v0.3.0
+ * @version v0.3.2
  * @author Alexey Vasiliev
  * @homepage https://github.com/le0pard/re2js#readme
  * @repository github:le0pard/re2js
@@ -702,9 +702,19 @@
     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;
     }
@@ -718,12 +728,26 @@
     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;
     }
@@ -737,12 +761,27 @@
     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;
     }
@@ -750,6 +789,7 @@
   class MatcherInput {
     /**
      * Return the MatcherInput for UTF_16 encoding.
+     * @returns {Utf16MatcherInput}
      */
     static utf16(charSequence) {
       return new Utf16MatcherInput(charSequence);
@@ -757,6 +797,7 @@
 
     /**
      * Return the MatcherInput for UTF_8 encoding.
+     * @returns {Utf8MatcherInput}
      */
     static utf8(input) {
       if (Array.isArray(input)) {
@@ -863,7 +904,7 @@
      * 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) {
@@ -878,6 +919,11 @@
         return s;
       }).join('');
     }
+    /**
+     *
+     * @param {RE2JS} pattern
+     * @param {Utf8MatcherInput|Utf16MatcherInput|number[]|string} input
+     */
     constructor(pattern, input) {
       if (pattern === null) {
         throw new Error('pattern is null');
@@ -899,7 +945,10 @@
       }
     }
 
-    /** Returns the {@code RE2JS} associated with this {@code Matcher}. */
+    /**
+     * Returns the {@code RE2JS} associated with this {@code Matcher}.
+     * @returns {RE2JS}
+     */
     pattern() {
       return this.patternInput;
     }
@@ -907,7 +956,7 @@
     /**
      * 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.
@@ -926,7 +975,7 @@
 
     /**
      * 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) {
@@ -940,7 +989,8 @@
     /**
      * 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;
@@ -958,7 +1008,8 @@
     /**
      * 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;
@@ -975,7 +1026,8 @@
 
     /**
      * 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;
@@ -1054,7 +1106,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 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
      */
@@ -1137,9 +1189,10 @@
      *
      * @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;
@@ -1157,6 +1210,7 @@
     /**
      * @param {string} replacement - the replacement string
      * @returns {string}
+     * @private
      */
     appendReplacementInternal(replacement) {
       let res = '';
@@ -1222,6 +1276,7 @@
     /**
      * @param {string} replacement - the replacement string
      * @returns {string}
+     * @private
      */
     appendReplacementInternalPerl(replacement) {
       let res = '';
@@ -3091,6 +3146,8 @@
     }
     /**
      * 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();
@@ -5563,7 +5620,7 @@
     /**
      * 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) {
@@ -5595,7 +5652,7 @@
      * 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
      */
@@ -5603,7 +5660,10 @@
       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');
@@ -5616,6 +5676,12 @@
       p.re2Input = re2;
       return p;
     }
+
+    /**
+     *
+     * @param {string} pattern
+     * @param {number} flags
+     */
     constructor(pattern, flags) {
       // The pattern string at construction time.
       this.patternInput = pattern;
@@ -5653,7 +5719,7 @@
     /**
      * 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) {
@@ -5663,7 +5729,7 @@
     /**
      * 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) {
@@ -5684,8 +5750,8 @@
      * 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;
@@ -5735,6 +5801,11 @@
       }
       return result;
     }
+
+    /**
+     *
+     * @returns {string}
+     */
     toString() {
       return this.patternInput;
     }
@@ -5757,6 +5828,12 @@
     namedGroups() {
       return this.re2Input.namedGroups;
     }
+
+    /**
+     *
+     * @param {*} other
+     * @returns {boolean}
+     */
     equals(other) {
       if (this === other) {
         return true;