rregex 1.11.0 → 1.12.0

package/lib/esm.mjs

@@ -191,69 +191,214 @@ export class RRegex {
         wasm.__wbg_rregex_free(ptr, 0);
     }
     /**
-     * Compiles a regular expression. Once compiled, it can be used repeatedly
-     * to search, split or replace text in a string.
+     * 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`.
      *
-     * If an invalid expression is given, then an error is returned.
-     * @param {string} re
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match_at
+     * @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}
      */
-    constructor(re) {
-        const ptr0 = passStringToWasm0(re, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    isMatchAt(text, start) {
+        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_new(ptr0, len0);
+        const ret = wasm.rregex_isMatchAt(this.__wbg_ptr, ptr0, len0, start);
+        return ret !== 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 - 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) {
+        let deferred3_0;
+        let deferred3_1;
+        try {
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ptr1 = passStringToWasm0(rep, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            const ret = wasm.rregex_replaceAll(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+            deferred3_0 = ret[0];
+            deferred3_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
+        }
+    }
+    /**
+     * 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
+     * import { RRegex } from "rregex"
+     *
+     * const re = new RRegex("'(?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) {
+        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.rregex_capturesAll(this.__wbg_ptr, ptr0, len0);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
-        this.__wbg_ptr = ret[0] >>> 0;
-        RRegexFinalization.register(this, this.__wbg_ptr, this);
-        return this;
+        return takeFromExternrefTable0(ret[0]);
     }
     /**
-     * Returns true if and only if there is a match for the regex in the
-     * string given.
+     * Returns the number of captures.
      *
-     * 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.
+     * 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
+     *  import { RRegex } from "rregex"
+     *
+     *  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;
+    }
+    /**
+     * Returns a list of the capture names in this regex.
+     *
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.capture_names
+     */
+    captureNames() {
+        const ret = wasm.rregex_captureNames(this.__wbg_ptr);
+        var v1 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
+        return v1;
+    }
+    /**
+     * Returns the end location of a match in the text given.
+     *
+     * 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
      *
-     * Test if some text contains at least one word with exactly 13
-     * Unicode word characters:
+     * 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
      * import { RRegex } from "rregex"
      *
-     * const text = "I categorically deny having triskaidekaphobia."
-     * expect(new RRegex("\b\w{13}\b").is_match(text)).toBe(true)
+     * const text = "aaaaa"
+     * const = new RRegex("a+").shortest_match(text)
+     * expect(pos).toBe(1)
      * ```
      *
-     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match
      * @param {string} text - The string against which to match the regular expression
-     * @return {boolean}
+     * @returns {number|undefined}
      */
-    isMatch(text) {
+    shortestMatch(text) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_isMatch(this.__wbg_ptr, ptr0, len0);
-        return ret !== 0;
+        const ret = wasm.rregex_shortestMatch(this.__wbg_ptr, ptr0, len0);
+        return ret === 0x100000001 ? undefined : ret;
     }
     /**
-     * Returns the same as is_match, but starts the search at the given offset.
+     * 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.is_match_at
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match_at
      * @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}
+     * @returns {number|undefined}
      */
-    isMatchAt(text, start) {
+    shortestMatchAt(text, start) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_isMatchAt(this.__wbg_ptr, ptr0, len0, start);
-        return ret !== 0;
+        const ret = wasm.rregex_shortestMatchAt(this.__wbg_ptr, ptr0, len0, start);
+        return ret === 0x100000001 ? undefined : ret;
+    }
+    /**
+     * 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
+     */
+    constructor(re) {
+        const ptr0 = passStringToWasm0(re, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.rregex_new(ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0] >>> 0;
+        RRegexFinalization.register(this, this.__wbg_ptr, this);
+        return this;
     }
     /**
      * Returns the start and end byte range of the leftmost-first match in
@@ -291,200 +436,103 @@ export class RRegex {
         return takeFromExternrefTable0(ret[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`.
+     * 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.
      *
-     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_at
-     * @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);
-        if (ret[2]) {
-            throw takeFromExternrefTable0(ret[1]);
-        }
-        return takeFromExternrefTable0(ret[0]);
-    }
-    /**
-     * Returns an array for each successive non-overlapping match in `text``,
-     * returning the start and end byte indices with respect to `text`.
+     * This method will *not* copy the text given.
      *
      * # Example
      *
-     * Find the start and end location of every word with exactly 13 Unicode
-     * word characters:
+     * To split a string delimited by arbitrary amounts of spaces or tabs:
      *
      * ```typescript
      * import { RRegex } from "rregex"
      *
-     * const text = "Retroactively relinquishing remunerations is reprehensible."
-     * const matches = new RRegex("\b\w{13}\b").findAll(text)
+     * const re = new RRegex(r"[ \t]+")
+     * const fields = re.split("a b 	  c	d    e")
+     * expect(fields).toEqual(["a", "b", "c", "d", "e"])
      * ```
      *
-     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_iter
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.split
      * @param {string} text - The string against which to match the regular expression
-     * @returns {Match}
+     * @returns {string[]}
      */
-    findAll(text) {
+    split(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);
-        if (ret[2]) {
-            throw takeFromExternrefTable0(ret[1]);
-        }
-        return takeFromExternrefTable0(ret[0]);
-    }
-    /**
-     * Returns a list of the capture names in this regex.
-     *
-     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.capture_names
-     */
-    captureNames() {
-        const ret = wasm.rregex_captureNames(this.__wbg_ptr);
-        var v1 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
+        const ret = wasm.rregex_split(this.__wbg_ptr, ptr0, len0);
+        var v2 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
         wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
-        return v1;
+        return v2;
     }
     /**
-     * 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
-     * import { RRegex } from "rregex"
+     * 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.
      *
-     * const re = new RRegex("'([^']+)'\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)")
-     * ```
+     * This method will *not* copy the text given.
      *
-     * Note that the full match is at capture group `0`. Each subsequent
-     * capture group is indexed by the order of its opening `(`.
+     * # Example
      *
-     * We can make this example a bit clearer by using *named* capture groups:
+     * Get the first two words in some text:
      *
      * ```typescript
      * import { RRegex } from "rregex"
      *
-     * const re = new RRegex("'(?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)")
+     * const re = new RRegex(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.captures
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.splitn
      * @param {string} text - The string against which to match the regular expression
-     * @returns {Captures|undefined}
+     * @param {number} limit - Max number result elements
+     * @returns {string[]}
      */
-    captures(text) {
+    splitn(text, limit) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_captures(this.__wbg_ptr, ptr0, len0);
+        const ret = wasm.rregex_splitn(this.__wbg_ptr, ptr0, len0, limit);
+        var v2 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
+        return v2;
+    }
+    /**
+     * Returns the regular expression into a high level intermediate
+     * representation.
+     * @returns {any}
+     */
+    syntax() {
+        const ret = wasm.rregex_syntax(this.__wbg_ptr);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
         return takeFromExternrefTable0(ret[0]);
     }
     /**
-     * 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
-     * import { RRegex } from "rregex"
+     * Returns the same as find, but starts the search at the given
+     * offset.
      *
-     * const re = new RRegex("'(?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
-     * ```
+     * 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.captures_iter
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_at
      * @param {string} text - The string against which to match the regular expression
-     * @returns {Captures[]}
+     * @param {number} start - Zero-based index at which to start matching
+     * @returns {Match}
      */
-    capturesAll(text) {
+    findAt(text, start) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_capturesAll(this.__wbg_ptr, ptr0, len0);
+        const ret = wasm.rregex_findAt(this.__wbg_ptr, ptr0, len0, start);
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
         return takeFromExternrefTable0(ret[0]);
     }
-    /**
-     * 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
-     *  import { RRegex } from "rregex"
-     *
-     *  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
@@ -577,197 +625,149 @@ 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.
-     *
-     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replacen
-     * @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) {
-        let deferred3_0;
-        let deferred3_1;
-        try {
-            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-            const len0 = WASM_VECTOR_LEN;
-            const ptr1 = passStringToWasm0(rep, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-            const len1 = WASM_VECTOR_LEN;
-            const ret = wasm.rregex_replacen(this.__wbg_ptr, ptr0, len0, limit, ptr1, len1);
-            deferred3_0 = ret[0];
-            deferred3_1 = ret[1];
-            return getStringFromWasm0(ret[0], ret[1]);
-        } finally {
-            wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
-        }
-    }
-    /**
-     * 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 - 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) {
-        let deferred3_0;
-        let deferred3_1;
-        try {
-            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-            const len0 = WASM_VECTOR_LEN;
-            const ptr1 = passStringToWasm0(rep, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-            const len1 = WASM_VECTOR_LEN;
-            const ret = wasm.rregex_replaceAll(this.__wbg_ptr, ptr0, len0, ptr1, len1);
-            deferred3_0 = ret[0];
-            deferred3_1 = ret[1];
-            return getStringFromWasm0(ret[0], ret[1]);
-        } finally {
-            wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
-        }
-    }
-    /**
-     * 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.
+     * 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.
      *
-     * This method will *not* copy the text given.
+     * 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.
      *
-     * # Example
+     * # Examples
      *
-     * To split a string delimited by arbitrary amounts of spaces or tabs:
+     * 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
      * import { RRegex } from "rregex"
      *
-     * const re = new RRegex(r"[ \t]+")
-     * const fields = re.split("a b 	  c	d    e")
-     * expect(fields).toEqual(["a", "b", "c", "d", "e"])
+     * const re = new RRegex("'([^']+)'\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)")
      * ```
      *
-     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.split
+     * 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
+     * import { RRegex } from "rregex"
+     *
+     * const re = new RRegex("'(?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 {string[]}
+     * @returns {Captures|undefined}
      */
-    split(text) {
+    captures(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);
-        var v2 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
-        wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
-        return v2;
+        const ret = wasm.rregex_captures(this.__wbg_ptr, ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
     }
     /**
-     * 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 array for each successive non-overlapping match in `text``,
+     * returning the start and end byte indices with respect to `text`.
      *
      * # Example
      *
-     * Get the first two words in some text:
+     * Find the start and end location of every word with exactly 13 Unicode
+     * word characters:
      *
      * ```typescript
      * import { RRegex } from "rregex"
      *
-     * const re = new RRegex(r"\W+")
-     * const fields = re.splitn("Hey! How are you?", 3)
-     * expect(fields).toEqual(["Hey", "How", "are you?"])
+     * const text = "Retroactively relinquishing remunerations is reprehensible."
+     * const matches = new RRegex("\b\w{13}\b").findAll(text)
      * ```
-     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.splitn
+     *
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_iter
      * @param {string} text - The string against which to match the regular expression
-     * @param {number} limit - Max number result elements
-     * @returns {string[]}
+     * @returns {Match}
      */
-    splitn(text, limit) {
+    findAll(text) {
         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);
-        var v2 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
-        wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
-        return v2;
+        const ret = wasm.rregex_findAll(this.__wbg_ptr, ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
     }
     /**
-     * Returns the end location of a match in the text given.
-     *
-     * 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`.
+     * Returns true if and only if there is a match for the regex in the
+     * string given.
      *
-     * 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.
+     * 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
      *
-     * 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`.
+     * Test if some text contains at least one word with exactly 13
+     * Unicode word characters:
      *
      * ```typescript
      * import { RRegex } from "rregex"
      *
-     * const text = "aaaaa"
-     * const = new RRegex("a+").shortest_match(text)
-     * expect(pos).toBe(1)
+     * 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.shortest_match
+     * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match
      * @param {string} text - The string against which to match the regular expression
-     * @returns {number|undefined}
+     * @return {boolean}
      */
-    shortestMatch(text) {
+    isMatch(text) {
         const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_shortestMatch(this.__wbg_ptr, ptr0, len0);
-        return ret === 0x100000001 ? undefined : ret;
+        const ret = wasm.rregex_isMatch(this.__wbg_ptr, ptr0, len0);
+        return ret !== 0;
     }
     /**
-     * Returns the same as `shortest_match`, but starts the search at the
-     * given offset.
+     * Replaces at most `limit` non-overlapping matches in `text` with the
+     * replacement provided. If `limit` is 0, then all non-overlapping matches
+     * are replaced.
      *
-     * 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
+     * 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 - 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, start) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregex_shortestMatchAt(this.__wbg_ptr, ptr0, len0, start);
-        return ret === 0x100000001 ? undefined : ret;
-    }
-    /**
-     * Returns the regular expression into a high level intermediate
-     * representation.
-     * @returns {any}
+     * @param {number} limit - Max number of replacement
+     * @param {string} rep - It's a string, it will replace the substring matched by `pattern`.
+     * @returns {string}
      */
-    syntax() {
-        const ret = wasm.rregex_syntax(this.__wbg_ptr);
-        if (ret[2]) {
-            throw takeFromExternrefTable0(ret[1]);
+    replacen(text, limit, rep) {
+        let deferred3_0;
+        let deferred3_1;
+        try {
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ptr1 = passStringToWasm0(rep, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            const ret = wasm.rregex_replacen(this.__wbg_ptr, ptr0, len0, limit, ptr1, len1);
+            deferred3_0 = ret[0];
+            deferred3_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
         }
-        return takeFromExternrefTable0(ret[0]);
     }
     /**
      * Returns a string representing the regular expression
@@ -842,43 +842,6 @@ export class RRegexSet {
         RRegexSetFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
-    /**
-     * 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
-     * import { RegexSet } from "rregex"
-     *
-     * 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 - The string against which to match the regular expression
-     * @return {boolean}
-     */
-    isMatch(text) {
-        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        const len0 = WASM_VECTOR_LEN;
-        const ret = wasm.rregexset_isMatch(this.__wbg_ptr, ptr0, len0);
-        return ret !== 0;
-    }
     /**
      * Returns the set of regular expressions that match in the given text.
      *
@@ -925,57 +888,94 @@ export class RRegexSet {
         wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
         return v2;
     }
+    /**
+     * 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
+     * import { RegexSet } from "rregex"
+     *
+     * 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 - The string against which to match the regular expression
+     * @return {boolean}
+     */
+    isMatch(text) {
+        const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.rregexset_isMatch(this.__wbg_ptr, ptr0, len0);
+        return ret !== 0;
+    }
 }
 
 const imports = {
     wbg: {
-        __wbg_buffer_61b7ce01341d7f88: function(arg0) {
+        __wbg_buffer_609cc3eee51ed158: function(arg0) {
             const ret = arg0.buffer;
             return ret;
         },
-        __wbg_fromCodePoint_ef89154c4db48bdf: function() { return handleError(function (arg0) {
+        __wbg_fromCodePoint_f37c25c172f2e8b5: function() { return handleError(function (arg0) {
             const ret = String.fromCodePoint(arg0 >>> 0);
             return ret;
         }, arguments) },
-        __wbg_from_d68eaa96dba25449: function(arg0) {
+        __wbg_from_2a5d3e218e67aa85: function(arg0) {
             const ret = Array.from(arg0);
             return ret;
         },
-        __wbg_get_9aa3dff3f0266054: function(arg0, arg1) {
+        __wbg_get_b9b93047fe3cf45b: function(arg0, arg1) {
             const ret = arg0[arg1 >>> 0];
             return ret;
         },
-        __wbg_length_d65cf0786bfc5739: function(arg0) {
+        __wbg_length_e2d2a49132c1b256: function(arg0) {
             const ret = arg0.length;
             return ret;
         },
-        __wbg_new_254fa9eac11932ae: function() {
-            const ret = new Array();
+        __wbg_new_405e22f390576ce2: function() {
+            const ret = new Object();
             return ret;
         },
-        __wbg_new_3ff5b33b1ce712df: function(arg0) {
-            const ret = new Uint8Array(arg0);
+        __wbg_new_78feb108b6472713: function() {
+            const ret = new Array();
             return ret;
         },
-        __wbg_new_688846f374351c92: function() {
-            const ret = new Object();
+        __wbg_new_a12002a7f91c75be: function(arg0) {
+            const ret = new Uint8Array(arg0);
             return ret;
         },
-        __wbg_newwithbyteoffsetandlength_ba35896968751d91: function(arg0, arg1, arg2) {
+        __wbg_newwithbyteoffsetandlength_d97e637ebe145a9a: function(arg0, arg1, arg2) {
             const ret = new Uint8Array(arg0, arg1 >>> 0, arg2 >>> 0);
             return ret;
         },
-        __wbg_push_6edad0df4b546b2c: function(arg0, arg1) {
+        __wbg_push_737cfc8c1432c2c6: function(arg0, arg1) {
             const ret = arg0.push(arg1);
             return ret;
         },
-        __wbg_set_1d80752d0d5f0b21: function(arg0, arg1, arg2) {
+        __wbg_set_37837023f3d740e8: function(arg0, arg1, arg2) {
             arg0[arg1 >>> 0] = arg2;
         },
         __wbg_set_3f1d0b984ed272ed: function(arg0, arg1, arg2) {
             arg0[arg1] = arg2;
         },
-        __wbg_set_4e647025551483bd: function() { return handleError(function (arg0, arg1, arg2) {
+        __wbg_set_bb8cecf6a62b9f46: function() { return handleError(function (arg0, arg1, arg2) {
             const ret = Reflect.set(arg0, arg1, arg2);
             return ret;
         }, arguments) },
@@ -1054,6 +1054,6 @@ export const metadata = {
   ],
   "homepage": "http://rregex.dev",
   "repository": "https://github.com/2fd/rregex",
-  "regex": "1.11.1",
-  "regex-syntax": "0.8.5"
+  "regex": "1.12.4",
+  "regex-syntax": "0.8.11"
 }