rregex 1.7.1 → 1.9.0

package/lib/browser.js

@@ -4,10 +4,19 @@ const heap = new Array(128).fill(undefined);
 
 heap.push(undefined, null, true, false);
 
-function getObject(idx) { return heap[idx]; }
-
 let heap_next = heap.length;
 
+function addHeapObject(obj) {
+    if (heap_next === heap.length) heap.push(heap.length + 1);
+    const idx = heap_next;
+    heap_next = heap[idx];
+
+    heap[idx] = obj;
+    return idx;
+}
+
+function getObject(idx) { return heap[idx]; }
+
 function dropObject(idx) {
     if (idx < 132) return;
     heap[idx] = heap_next;
@@ -38,15 +47,6 @@ function getStringFromWasm0(ptr, len) {
     return cachedTextDecoder.decode(getUint8Memory0().subarray(ptr, ptr + len));
 }
 
-function addHeapObject(obj) {
-    if (heap_next === heap.length) heap.push(heap.length + 1);
-    const idx = heap_next;
-    heap_next = heap[idx];
-
-    heap[idx] = obj;
-    return idx;
-}
-
 let WASM_VECTOR_LEN = 0;
 
 const cachedTextEncoder = (typeof TextEncoder !== 'undefined' ? new TextEncoder('utf-8') : { encode: () => { throw Error('TextEncoder not available') } } );
@@ -115,69 +115,24 @@ function getInt32Memory0() {
     return cachedInt32Memory0;
 }
 
-function debugString(val) {
-    // primitive types
-    const type = typeof val;
-    if (type == 'number' || type == 'boolean' || val == null) {
-        return  `${val}`;
-    }
-    if (type == 'string') {
-        return `"${val}"`;
-    }
-    if (type == 'symbol') {
-        const description = val.description;
-        if (description == null) {
-            return 'Symbol';
-        } else {
-            return `Symbol(${description})`;
-        }
-    }
-    if (type == 'function') {
-        const name = val.name;
-        if (typeof name == 'string' && name.length > 0) {
-            return `Function(${name})`;
-        } else {
-            return 'Function';
-        }
-    }
-    // objects
-    if (Array.isArray(val)) {
-        const length = val.length;
-        let debug = '[';
-        if (length > 0) {
-            debug += debugString(val[0]);
-        }
-        for(let i = 1; i < length; i++) {
-            debug += ', ' + debugString(val[i]);
-        }
-        debug += ']';
-        return debug;
-    }
-    // Test for built-in
-    const builtInMatches = /\[object ([^\]]+)\]/.exec(toString.call(val));
-    let className;
-    if (builtInMatches.length > 1) {
-        className = builtInMatches[1];
-    } else {
-        // Failed to match the standard '[object ClassName]'
-        return toString.call(val);
-    }
-    if (className == 'Object') {
-        // we're a user defined class or Object
-        // JSON.stringify avoids problems with cycles, and is generally much
-        // easier than looping through ownProperties of `val`.
-        try {
-            return 'Object(' + JSON.stringify(val) + ')';
-        } catch (_) {
-            return 'Object';
-        }
+let cachedUint32Memory0 = null;
+
+function getUint32Memory0() {
+    if (cachedUint32Memory0 === null || cachedUint32Memory0.byteLength === 0) {
+        cachedUint32Memory0 = new Uint32Array(wasm.memory.buffer);
     }
-    // errors
-    if (val instanceof Error) {
-        return `${val.name}: ${val.message}\n${val.stack}`;
+    return cachedUint32Memory0;
+}
+
+function getArrayJsValueFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    const mem = getUint32Memory0();
+    const slice = mem.subarray(ptr / 4, ptr / 4 + len);
+    const result = [];
+    for (let i = 0; i < slice.length; i++) {
+        result.push(takeObject(slice[i]));
     }
-    // TODO we could test for more things here, like `Set`s and `Map`s.
-    return className;
+    return result;
 }
 
 let stack_pointer = 128;
@@ -188,6 +143,10 @@ function addBorrowedObject(obj) {
     return stack_pointer;
 }
 /**
+* Escapes all regular expression meta characters in `text`.
+*
+* The string returned may be safely used as a literal in a regular
+* expression.
 * @param {string} text
 * @returns {string}
 */
@@ -235,7 +194,9 @@ export class RRegex {
         wasm.__wbg_rregex_free(ptr);
     }
     /**
-    * Compiles a regular expression. Once compiled, it can be used repeatedly to search, split or replace text in a string.
+    * Compiles a regular expression. Once compiled, it can be used repeatedly
+    * to search, split or replace text in a string.
+    *
     * If an invalid expression is given, then an error is returned.
     * @param {string} re
     */
@@ -258,11 +219,26 @@ export class RRegex {
         }
     }
     /**
-    * Returns true if and only if there is a match for the regex in the string given.
-    * It is recommended to use this method if all you need to do is test a match, since the underlying matching engine may be able to do less work.
+    * Returns true if and only if there is a match for the regex in the
+    * string given.
+    *
+    * It is recommended to use this method if all you need to do is test
+    * a match, since the underlying matching engine may be able to do less
+    * work.
+    *
+    * # Example
+    *
+    * Test if some text contains at least one word with exactly 13
+    * Unicode word characters:
+    *
+    * ```typescript
+    * const text = "I categorically deny having triskaidekaphobia."
+    * expect(new RRegex("\\b\\w{13}\\b").is_match(text)).toBe(true)
+    * ```
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match
-    * @param {string} text
-    * @returns {boolean}
+    * @param {string} text - The string against which to match the regular expression
+    * @return {boolean}
     */
     isMatch(text) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -272,11 +248,14 @@ export class RRegex {
     }
     /**
     * Returns the same as is_match, but starts the search at the given offset.
-    * The significance of the starting point is that it takes the surrounding context into consideration. For example, the `\A` anchor can only match when `start == 0`.
+    * The significance of the starting point is that it takes the surrounding
+    * context into consideration. For example, the `\A` anchor can only match
+    * when `start == 0`.
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match_at
-    * @param {string} text
-    * @param {number} start
-    * @returns {boolean}
+    * @param {string} text - The string against which to match the regular expression
+    * @param {number} start - Zero-based index at which to start matching
+    * @return {boolean}
     */
     isMatchAt(text, start) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -285,51 +264,337 @@ export class RRegex {
         return ret !== 0;
     }
     /**
-    * Returns the start and end byte range of the leftmost-first match in `text`. If no match exists, then `undefined` is returned.
-    * Note that this should only be used if you want to discover the position of the match. Testing the existence of a match is faster if you use `is_match`.
+    * Returns the start and end byte range of the leftmost-first match in
+    * `text`. If no match exists, then `undefined` is returned.
+    *
+    * Note that this should only be used if you want to discover the position
+    * of the match. Testing the existence of a match is faster if you use
+    * `isMatch`.
+    *
+    * # Example
+    *
+    * Find the start and end location of the first word with exactly 13
+    * Unicode word characters:
+    *
+    * ```typescript
+    * const text = "I categorically deny having triskaidekaphobia."
+    * const m = new Regex("\\b\\w{13}\\b").find(text)
+    * expect(m.start).toBe(2)
+    * expect(m.end).toBe(15)
+    * ```
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find
-    * @param {string} text
-    * @returns {any}
+    * @param {string} text - The string against which to match the regular expression
+    * @return {Match}
     */
     find(text) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_find(this.__wbg_ptr, ptr0, len0);
-        return takeObject(ret);
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregex_find(retptr, this.__wbg_ptr, ptr0, len0);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
     }
     /**
-    * Returns the same as find, but starts the search at the given offset.
-    * The significance of the starting point is that it takes the surrounding context into consideration. For example, the \A anchor can only match when `start == 0`.
+    * Returns the same as find, but starts the search at the given
+    * offset.
+    *
+    * The significance of the starting point is that it takes the surrounding
+    * context into consideration. For example, the `\A` anchor can only
+    * match when `start == 0`.
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_at
-    * @param {string} text
-    * @param {number} start
-    * @returns {any}
+    * @param {string} text - The string against which to match the regular expression
+    * @param {number} start - Zero-based index at which to start matching
+    * @returns {Match}
     */
     findAt(text, start) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_findAt(this.__wbg_ptr, ptr0, len0, start);
-        return takeObject(ret);
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregex_findAt(retptr, this.__wbg_ptr, ptr0, len0, start);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
     }
     /**
-    * Returns an array for each successive non-overlapping match in text, returning the start and end byte indices with respect to text.
+    * Returns an array for each successive non-overlapping match in `text``,
+    * returning the start and end byte indices with respect to `text`.
+    *
+    * # Example
+    *
+    * Find the start and end location of every word with exactly 13 Unicode
+    * word characters:
+    *
+    * ```typescript
+    * const text = "Retroactively relinquishing remunerations is reprehensible."
+    * const matches = new Regex("\\b\\w{13}\\b").findAll(text)
+    * ```
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_iter
-    * @param {string} text
-    * @returns {any}
+    * @param {string} text - The string against which to match the regular expression
+    * @returns {Match}
     */
     findAll(text) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_findAll(this.__wbg_ptr, ptr0, len0);
-        return takeObject(ret);
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregex_findAll(retptr, this.__wbg_ptr, ptr0, len0);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+    * Returns a list of the capture names in this regex.
+    *
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.capture_names
+    */
+    captureNames() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.rregex_captureNames(retptr, this.__wbg_ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var v1 = getArrayJsValueFromWasm0(r0, r1).slice();
+            wasm.__wbindgen_free(r0, r1 * 4, 4);
+            return v1;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+    * Returns the capture groups corresponding to the leftmost-first
+    * match in `text`. Capture group `0` always corresponds to the entire
+    * match. If no match is found, then `undefined` is returned.
+    *
+    * You should only use `captures` if you need access to the location of
+    * capturing group matches. Otherwise, `find` is faster for discovering
+    * the location of the overall match.
+    *
+    * # Examples
+    *
+    * Say you have some text with movie names and their release years,
+    * like "'Citizen Kane' (1941)". It'd be nice if we could search for text
+    * looking like that, while also extracting the movie name and its release
+    * year separately.
+    *
+    * ```typescript
+    * const re = new Regex("'([^']+)'\\s+\\((\\d{4})\)")
+    * const text = "Not my favorite movie: 'Citizen Kane' (1941)."
+    * const caps = re.captures(text)
+    * expect(caps.get[1].value).toBe("Citizen Kane")
+    * expect(caps.get[2].value).toBe("1941")
+    * expect(caps.get[0].value).toBe("'Citizen Kane' (1941)")
+    * ```
+    *
+    * Note that the full match is at capture group `0`. Each subsequent
+    * capture group is indexed by the order of its opening `(`.
+    *
+    * We can make this example a bit clearer by using *named* capture groups:
+    *
+    * ```typescript
+    * const re = new Regex("'(?P<title>[^']+)'\\s+\\((?P<year>\\d{4})\)")
+    * const text = "Not my favorite movie: 'Citizen Kane' (1941)."
+    * const caps = re.captures(text)
+    * expect(caps.name["title"].value).toBe("Citizen Kane")
+    * expect(caps.name["year"].value).toBe("1941")
+    * expect(caps.get[0].value).toBe("'Citizen Kane' (1941)")
+    * ```
+    *
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.captures
+    * @param {string} text - The string against which to match the regular expression
+    * @returns {Captures|undefined}
+    */
+    captures(text) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregex_captures(retptr, this.__wbg_ptr, ptr0, len0);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+    * Returns a list with all the non-overlapping capture groups matched
+    * in `text`. This is operationally the same as `findAll`, except it
+    * returns information about capturing group matches.
+    *
+    * # Example
+    *
+    * We can use this to find all movie titles and their release years in
+    * some text, where the movie is formatted like "'Title' (xxxx)":
+    *
+    * ```typescript
+    * const re = new Regex("'(?P<title>[^']+)'\\s+\\((?P<year>\\d{4})\\)")
+    * const text = "'Citizen Kane' (1941), 'The Wizard of Oz' (1939), 'M' (1931)."
+    * for caps of re.captures_iter(text) {
+    *     console.log(
+    *         "Movie:", caps.name["title"].value, ","
+    *         "Released:", caps.name["year"].value
+    *     );
+    * }
+    * // Output:
+    * // Movie: Citizen Kane, Released: 1941
+    * // Movie: The Wizard of Oz, Released: 1939
+    * // Movie: M, Released: 1931
+    * ```
+    *
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.captures_iter
+    * @param {string} text - The string against which to match the regular expression
+    * @returns {Captures[]}
+    */
+    capturesAll(text) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregex_capturesAll(retptr, this.__wbg_ptr, ptr0, len0);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+    * Returns the number of captures.
+    *
+    * This includes all named and unnamed groups, including the implicit
+    * unnamed group that is always present and corresponds to the entire match.
+    *
+    * Since the implicit unnamed group is always included in this length, the
+    * length returned is guaranteed to be greater than zero.
+    *
+    * ## Example
+    *
+    * ```typescript
+    *  const re1 = new RRegex("(?P<y>\\d{4})-(?P<m>\\d{2})-(?P<d>\\d{2})")
+    *  expect(re1.capturesLength()).toEqual(4)
+    *
+    *  const re2 = new RRegex("foo")
+    *  expect(re2.capturesLength()).toEqual(1)
+    *
+    *  const re3 = new RRegex("(foo)")
+    *  expect(re3.capturesLength()).toEqual(2)
+    *
+    *  const re4 = new RRegex("(?<a>.(?<b>.))(.)(?:.)(?<c>.)")
+    *  expect(re4.capturesLength()).toEqual(5)
+    *
+    *  const re5 = new RRegex("[a&&b]")
+    *  expect(re5.capturesLength()).toEqual(1)
+    * ```
+    *
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.captures_len
+    * @returns {number}
+    */
+    capturesLength() {
+        const ret = wasm.rregex_capturesLength(this.__wbg_ptr);
+        return ret >>> 0;
     }
     /**
     * Replaces the leftmost-first match with the replacement provided.
-    * The replacement can be a regular string (where `$N` and `$name` are expanded to match capture groups) or a function that takes the matches’ `Captures` and returns the replaced string.
+    * The replacement can be a regular string (where `$N` and `$name` are
+    * expanded to match capture groups) or a function that takes the matches'
+    * `Captures` and returns the replaced string.
+    *
     * If no match is found, then a copy of the string is returned unchanged.
+    *
+    * # Replacement string syntax
+    *
+    * All instances of `$name` in the replacement text is replaced with the
+    * corresponding capture group `name`.
+    *
+    * `name` may be an integer corresponding to the index of the
+    * capture group (counted by order of opening parenthesis where `0` is the
+    * entire match) or it can be a name (consisting of letters, digits or
+    * underscores) corresponding to a named capture group.
+    *
+    * If `name` isn't a valid capture group (whether the name doesn't exist
+    * or isn't a valid index), then it is replaced with the empty string.
+    *
+    * The longest possible name is used. e.g., `$1a` looks up the capture
+    * group named `1a` and not the capture group at index `1`. To exert more
+    * precise control over the name, use braces, e.g., `${1}a`.
+    *
+    * To write a literal `$` use `$$`.
+    *
+    * # Examples
+    *
+    * Note that this function is polymorphic with respect to the replacement.
+    * In typical usage, this can just be a normal string:
+    *
+    * ```typescript
+    * const re = new Regex("[^01]+")
+    * expect(re.replace("1078910", "").toBe("1010")
+    * ```
+    *
+    * Here's the example using this expansion technique with named capture
+    * groups:
+    *
+    * ```typescript
+    * const re = new Regex("(?P<last>[^,\\s]+),\\s+(?P<first>\\S+)")
+    * const result = re.replace("Springsteen, Bruce", "$first $last")
+    * expect(result).toBe("Bruce Springsteen")
+    * ```
+    *
+    * Note that using `$2` instead of `$first` or `$1` instead of `$last`
+    * would produce the same result. To write a literal `$` use `$$`.
+    *
+    * Sometimes the replacement string requires use of curly braces to
+    * delineate a capture group replacement and surrounding literal text.
+    * For example, if we wanted to join two words together with an
+    * underscore:
+    *
+    * ```typescript
+    * const re = new Regex("(?P<first>\\w+)\\s+(?P<second>\\w+)")
+    * const result = re.replace("deep fried", "${first}_$second")
+    * expect(result).toBe("deep_fried")
+    * ```
+    *
+    * Without the curly braces, the capture group name `first_` would be
+    * used, and since it doesn't exist, it would be replaced with the empty
+    * string.
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace
-    * @param {string} text
-    * @param {string} rep
+    * @param {string} text - The string against which to match the regular expression
+    * @param {string} rep - It's a string, it will replace the substring matched by `pattern`.
     * @returns {string}
     */
     replace(text, rep) {
@@ -353,12 +618,17 @@ export class RRegex {
         }
     }
     /**
-    * Replaces at most `limit` non-overlapping matches in `text` with the replacement provided. If `limit` is 0, then all non-overlapping matches are replaced.
-    * See the documentation for `replace` for details on how to access capturing group matches in the replacement string.
+    * Replaces at most `limit` non-overlapping matches in `text` with the
+    * replacement provided. If `limit` is 0, then all non-overlapping matches
+    * are replaced.
+    *
+    * See the documentation for `replace` for details on how to access
+    * capturing group matches in the replacement string.
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replacen
-    * @param {string} text
-    * @param {number} limit
-    * @param {string} rep
+    * @param {string} text - The string against which to match the regular expression
+    * @param {number} limit - Max number of replacement
+    * @param {string} rep - It's a string, it will replace the substring matched by `pattern`.
     * @returns {string}
     */
     replacen(text, limit, rep) {
@@ -382,11 +652,17 @@ export class RRegex {
         }
     }
     /**
-    * Replaces all non-overlapping matches in `text` with the replacement provided. This is the same as calling `replacen` with `limit` set to `0`.
+    * Replaces all non-overlapping matches in `text` with the replacement
+    * provided. This is the same as calling `replacen` with `limit` set to
+    * `0`.
+    *
+    * See the documentation for `replace` for details on how to access
+    * capturing group matches in the replacement string.
+    *
     * See the documentation for `replace` for details on how to access capturing group matches in the replacement string.
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace_all
-    * @param {string} text
-    * @param {string} rep
+    * @param {string} text - The string against which to match the regular expression
+    * @param {string} rep - It's a string, it will replace the substring matched by `pattern`.
     * @returns {string}
     */
     replaceAll(text, rep) {
@@ -410,38 +686,109 @@ export class RRegex {
         }
     }
     /**
-    * Returns an iterator of substrings of `text` delimited by a match of the regular expression. Namely, each element of the iterator corresponds to text that isn’t matched by the regular expression.
-    * This method will not copy the text given.
+    * Returns an iterator of substrings of `text` delimited by a match of the
+    * regular expression. Namely, each element of the iterator corresponds to
+    * text that *isn't* matched by the regular expression.
+    *
+    * This method will *not* copy the text given.
+    *
+    * # Example
+    *
+    * To split a string delimited by arbitrary amounts of spaces or tabs:
+    *
+    * ```typescript
+    * const re = new Regex(r"[ \\t]+")
+    * const fields = re.split("a b \t  c\td    e")
+    * expect(fields).toEqual(["a", "b", "c", "d", "e"])
+    * ```
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.split
-    * @param {string} text
-    * @returns {any}
+    * @param {string} text - The string against which to match the regular expression
+    * @returns {string[]}
     */
     split(text) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_split(this.__wbg_ptr, ptr0, len0);
-        return takeObject(ret);
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregex_split(retptr, this.__wbg_ptr, ptr0, len0);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var v2 = getArrayJsValueFromWasm0(r0, r1).slice();
+            wasm.__wbindgen_free(r0, r1 * 4, 4);
+            return v2;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
     }
     /**
-    * Returns an iterator of at most `limit` substrings of `text` delimited by a match of the regular expression. (A limit of 0 will return no substrings.) Namely, each element of the iterator corresponds to text that isn’t matched by the regular expression. The remainder of the string that is not split will be the last element in the iterator.
-    * This method will not copy the text given.
+    * Returns an iterator of at most `limit` substrings of `text` delimited
+    * by a match of the regular expression. (A `limit` of `0` will return no
+    * substrings.) Namely, each element of the iterator corresponds to text
+    * that *isn't* matched by the regular expression. The remainder of the
+    * string that is not split will be the last element in the iterator.
+    *
+    * This method will *not* copy the text given.
+    *
+    * # Example
+    *
+    * Get the first two words in some text:
+    *
+    * ```typescript
+    * const re = new Regex(r"\\W+")
+    * const fields = re.splitn("Hey! How are you?", 3)
+    * expect(fields).toEqual(["Hey", "How", "are you?"])
+    * ```
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.splitn
-    * @param {string} text
-    * @param {number} limit
-    * @returns {any}
+    * @param {string} text - The string against which to match the regular expression
+    * @param {number} limit - Max number result elements
+    * @returns {string[]}
     */
     splitn(text, limit) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_splitn(this.__wbg_ptr, ptr0, len0, limit);
-        return takeObject(ret);
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregex_splitn(retptr, this.__wbg_ptr, ptr0, len0, limit);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var v2 = getArrayJsValueFromWasm0(r0, r1).slice();
+            wasm.__wbindgen_free(r0, r1 * 4, 4);
+            return v2;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
     }
     /**
     * Returns the end location of a match in the text given.
-    * This method may have the same performance characteristics as `is_match`, except it provides an end location for a match. In particular, the location returned may be shorter than the proper end of the leftmost-first match.
+    *
+    * This method may have the same performance characteristics as
+    * `isMatch`, except it provides an end location for a match. In
+    * particular, the location returned *may be shorter* than the proper end
+    * of the leftmost-first match that you would find via `Regex.find`.
+    *
+    * Note that it is not guaranteed that this routine finds the shortest or
+    * "earliest" possible match. Instead, the main idea of this API is that
+    * it returns the offset at the point at which the internal regex engine
+    * has determined that a match has occurred. This may vary depending on
+    * which internal regex engine is used, and thus, the offset itself may
+    * change.
+    *
+    * # Example
+    *
+    * Typically, `a+` would match the entire first sequence of `a` in some
+    * text, but `shortest_match` can give up as soon as it sees the first
+    * `a`.
+    *
+    * ```typescript
+    * const text = "aaaaa"
+    * const = new Regex("a+").shortest_match(text)
+    * expect(pos).toBe(1)
+    * ```
+    *
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match
-    * @param {string} text
-    * @returns {number | undefined}
+    * @param {string} text - The string against which to match the regular expression
+    * @returns {number|undefined}
     */
     shortestMatch(text) {
         try {
@@ -457,19 +804,23 @@ export class RRegex {
         }
     }
     /**
-    * Returns the same as shortest_match, but starts the search at the given offset.
-    * The significance of the starting point is that it takes the surrounding context into consideration. For example, the \A anchor can only match when `start == 0`.
+    * Returns the same as `shortest_match`, but starts the search at the
+    * given offset.
+    *
+    * The significance of the starting point is that it takes the surrounding
+    * context into consideration. For example, the `\A` anchor can only match
+    * when `start == 0`.
     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match_at
-    * @param {string} text
-    * @param {number} limit
-    * @returns {number | undefined}
+    * @param {string} text - The string against which to match the regular expression
+    * @param {number} start - Zero-based index at which to start matching
+    * @returns {number|undefined}
     */
-    shortestMatchAt(text, limit) {
+    shortestMatchAt(text, start) {
         try {
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
             const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
             const len0 = WASM_VECTOR_LEN;
-            wasm.rregex_shortestMatchAt(retptr, this.__wbg_ptr, ptr0, len0, limit);
+            wasm.rregex_shortestMatchAt(retptr, this.__wbg_ptr, ptr0, len0, start);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
             return r0 === 0 ? undefined : r1 >>> 0;
@@ -478,12 +829,24 @@ export class RRegex {
         }
     }
     /**
-    * Return the Regex syntax object
+    * Returns the regular expression into a high level intermediate
+    * representation.
     * @returns {any}
     */
     syntax() {
-        const ret = wasm.rregex_syntax(this.__wbg_ptr);
-        return takeObject(ret);
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.rregex_syntax(retptr, this.__wbg_ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var r2 = getInt32Memory0()[retptr / 4 + 2];
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return takeObject(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
     }
     /**
     * Returns a string representing the regular expression
@@ -508,7 +871,14 @@ export class RRegex {
 }
 /**
 * Match multiple (possibly overlapping) regular expressions in a single scan.
-* A regex set corresponds to the union of two or more regular expressions. That is, a regex set will match text where at least one of its constituent regular expressions matches. A regex set as its formulated here provides a touch more power: it will also report which regular expressions in the set match. Indeed, this is the key difference between regex sets and a single `Regex` with many alternates, since only one alternate can match at a time.
+* A regex set corresponds to the union of two or more regular expressions.
+*
+* That is, a regex set will match text where at least one of its constituent
+* regular expressions matches. A regex set as its formulated here provides a
+* touch more power: it will also report which regular expressions in the set match.
+* Indeed, this is the key difference between regex sets and a single `Regex`
+* with many alternates, since only one alternate can match at a time.
+*
 * @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.empty
 */
 export class RRegexSet {
@@ -526,6 +896,18 @@ export class RRegexSet {
     }
     /**
     * Create a new regex set with the given regular expressions.
+    *
+    * This takes an of strings, if any item in the list is not a valid regular
+    * expressions, then an error is returned.
+    *
+    * # Example
+    *
+    * Create a new regex set from an iterator of strings:
+    *
+    * ```typescript
+    * const set = new RegexSet(["\\w+", "\\d+"])
+    * expect(set.is_match("foo")).toBe(true)
+    * ```
     * @param {Array<any>} list
     */
     constructor(list) {
@@ -546,11 +928,33 @@ export class RRegexSet {
         }
     }
     /**
-    * Returns true if and only if one of the regexes in this set matches the text given.
-    * This method should be preferred if you only need to test whether any of the regexes in the set should match, but don’t care about which regexes matched. This is because the underlying matching engine will quit immediately after seeing the first match instead of continuing to find all matches.
+    * Returns true if and only if one of the regexes in this set matches
+    * the text given.
+    *
+    * This method should be preferred if you only need to test whether any
+    * of the regexes in the set should match, but don't care about *which*
+    * regexes matched. This is because the underlying matching engine will
+    * quit immediately after seeing the first match instead of continuing to
+    * find all matches.
+    *
+    * Note that as with searches using `Regex`, the expression is unanchored
+    * by default. That is, if the regex does not start with `^` or `\A`, or
+    * end with `$` or `\z`, then it is permitted to match anywhere in the
+    * text.
+    *
+    * # Example
+    *
+    * Tests whether a set matches some text:
+    *
+    * ```typescript
+    * const set = new RegexSet(["\\w+", "\\d+"])
+    * expect(set.is_match("foo")).toBe(true)
+    * expect(!set.is_match("☃")).toBe(false)
+    * ```
+    *
     * @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.is_match
-    * @param {string} text
-    * @returns {boolean}
+    * @param {string} text - The string against which to match the regular expression
+    * @return {boolean}
     */
     isMatch(text) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -560,16 +964,54 @@ export class RRegexSet {
     }
     /**
     * Returns the set of regular expressions that match in the given text.
-    * The set returned contains the index of each regular expression that matches in the given text. The index is in correspondence with the order of regular expressions given to RegexSet’s constructor.
-    * the set can also be used to iterate over the matched indices.
-    * @param {string} text
-    * @returns {any}
+    *
+    * The set returned contains the index of each regular expression that
+    * matches in the given text. The index is in correspondence with the
+    * order of regular expressions given to `RegexSet`'s constructor.
+    *
+    * The set can also be used to iterate over the matched indices.
+    *
+    * Note that as with searches using `Regex`, the expression is unanchored
+    * by default. That is, if the regex does not start with `^` or `\A`, or
+    * end with `$` or `\z`, then it is permitted to match anywhere in the
+    * text.
+    *
+    * # Example
+    *
+    * Tests which regular expressions match the given text:
+    *
+    * ```typescript
+    * const set = new RegexSet([
+    *     "\\w+",
+    *     "\\d+",
+    *     "\\pL+",
+    *     "foo",
+    *     "bar",
+    *     "barfoo",
+    *     "foobar",
+    * ])
+    * const matches = set.matches("foobar")
+    * expect(matches).toBe([0, 2, 3, 4, 6])
+    * ```
+    *
+    * @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.matches
+    * @param {string} text - The string against which to match the regular expression
+    * @return {number[]}
     */
     matches(text) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregexset_matches(this.__wbg_ptr, ptr0, len0);
-        return takeObject(ret);
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.rregexset_matches(retptr, this.__wbg_ptr, ptr0, len0);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            var v2 = getArrayJsValueFromWasm0(r0, r1).slice();
+            wasm.__wbindgen_free(r0, r1 * 4, 4);
+            return v2;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
     }
 }
 
@@ -607,6 +1049,10 @@ async function __wbg_load(module, imports) {
 function __wbg_get_imports() {
     const imports = {};
     imports.wbg = {};
+    imports.wbg.__wbindgen_number_new = function(arg0) {
+        const ret = arg0;
+        return addHeapObject(ret);
+    };
     imports.wbg.__wbindgen_object_drop_ref = function(arg0) {
         takeObject(arg0);
     };
@@ -614,14 +1060,6 @@ function __wbg_get_imports() {
         const ret = getStringFromWasm0(arg0, arg1);
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_number_new = function(arg0) {
-        const ret = arg0;
-        return addHeapObject(ret);
-    };
-    imports.wbg.__wbindgen_is_string = function(arg0) {
-        const ret = typeof(getObject(arg0)) === 'string';
-        return ret;
-    };
     imports.wbg.__wbindgen_string_get = function(arg0, arg1) {
         const obj = getObject(arg1);
         const ret = typeof(obj) === 'string' ? obj : undefined;
@@ -630,6 +1068,21 @@ function __wbg_get_imports() {
         getInt32Memory0()[arg0 / 4 + 1] = len1;
         getInt32Memory0()[arg0 / 4 + 0] = ptr1;
     };
+    imports.wbg.__wbindgen_error_new = function(arg0, arg1) {
+        const ret = new Error(getStringFromWasm0(arg0, arg1));
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_object_clone_ref = function(arg0) {
+        const ret = getObject(arg0);
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_bigint_from_u64 = function(arg0) {
+        const ret = BigInt.asUintN(64, arg0);
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_set_9182712abebf82ef = function(arg0, arg1, arg2) {
+        getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
+    };
     imports.wbg.__wbg_get_f01601b5a68d10e3 = function(arg0, arg1) {
         const ret = getObject(arg0)[arg1 >>> 0];
         return addHeapObject(ret);
@@ -646,28 +1099,44 @@ function __wbg_get_imports() {
         const ret = new Object();
         return addHeapObject(ret);
     };
+    imports.wbg.__wbg_set_f2740edb12e318cd = function(arg0, arg1, arg2) {
+        getObject(arg0)[arg1 >>> 0] = takeObject(arg2);
+    };
+    imports.wbg.__wbg_from_71add2e723d1f1b2 = function(arg0) {
+        const ret = Array.from(getObject(arg0));
+        return addHeapObject(ret);
+    };
     imports.wbg.__wbg_push_901f3914205d44de = function(arg0, arg1) {
         const ret = getObject(arg0).push(getObject(arg1));
         return ret;
     };
-    imports.wbg.__wbg_new_a64e3f2afc2cf2f8 = function(arg0, arg1) {
-        const ret = new Error(getStringFromWasm0(arg0, arg1));
+    imports.wbg.__wbg_fromCodePoint_fd9383eff8873c75 = function() { return handleError(function (arg0) {
+        const ret = String.fromCodePoint(arg0 >>> 0);
+        return addHeapObject(ret);
+    }, arguments) };
+    imports.wbg.__wbg_buffer_a448f833075b71ba = function(arg0) {
+        const ret = getObject(arg0).buffer;
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_newwithbyteoffsetandlength_d0482f893617af71 = function(arg0, arg1, arg2) {
+        const ret = new Uint8Array(getObject(arg0), arg1 >>> 0, arg2 >>> 0);
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_new_8f67e318f15d7254 = function(arg0) {
+        const ret = new Uint8Array(getObject(arg0));
         return addHeapObject(ret);
     };
     imports.wbg.__wbg_set_759f75cd92b612d2 = function() { return handleError(function (arg0, arg1, arg2) {
         const ret = Reflect.set(getObject(arg0), getObject(arg1), getObject(arg2));
         return ret;
     }, arguments) };
-    imports.wbg.__wbindgen_debug_string = function(arg0, arg1) {
-        const ret = debugString(getObject(arg1));
-        const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len1 = WASM_VECTOR_LEN;
-        getInt32Memory0()[arg0 / 4 + 1] = len1;
-        getInt32Memory0()[arg0 / 4 + 0] = ptr1;
-    };
     imports.wbg.__wbindgen_throw = function(arg0, arg1) {
         throw new Error(getStringFromWasm0(arg0, arg1));
     };
+    imports.wbg.__wbindgen_memory = function() {
+        const ret = wasm.memory;
+        return addHeapObject(ret);
+    };
 
     return imports;
 }
@@ -680,6 +1149,7 @@ function __wbg_finalize_init(instance, module) {
     wasm = instance.exports;
     __wbg_init.__wbindgen_wasm_module = module;
     cachedInt32Memory0 = null;
+    cachedUint32Memory0 = null;
     cachedUint8Memory0 = null;
 
 
@@ -730,8 +1200,8 @@ export const metadata = {
   "authors": [
     "Fede Ramirez <i@2fd.me>"
   ],
-  "homepage": "https://2fd.github.io/rregex",
+  "homepage": "http://rregex.dev",
   "repository": "https://github.com/2fd/rregex",
-  "regex": "1.7.3",
-  "regex-syntax": "0.6.29"
+  "regex": "1.9.6",
+  "regex-syntax": "0.7.5"
 }