rregex 1.2.0 → 1.2.1

package/lib/{module.d.ts → esm.d.ts}

@@ -1,9 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
-* @param {string} text
-* @returns {string}
-*/
 export function escape(text: string): string;
 
 export type Hir = {
@@ -14,81 +10,6 @@ export type Hir = {
 
 
 
-export type HirKind =
-  | HirKindEmptyVariant
-  | HirKindLiteralVariant
-  | HirKindClassVariant
-  | HirKindAnchorVariant
-  | HirKindWordBoundaryVariant
-  | HirKindRepetitionVariant
-  | HirKindGroupVariant
-  | HirKindConcatVariant
-  | HirKindAlternationVariant
-
-export type HirKindEmptyVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Empty'
-}
-
-export type HirKindLiteralVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Literal'
-  '@values': [Literal]
-}
-
-export type HirKindClassVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Class'
-  '@values': [Class]
-}
-
-export type HirKindAnchorVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Anchor'
-  '@values': [Anchor]
-}
-
-export type HirKindWordBoundaryVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'WordBoundary'
-  '@values': [WordBoundary]
-}
-
-export type HirKindRepetitionVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Repetition'
-  '@values': [Repetition]
-}
-
-export type HirKindGroupVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Group'
-  '@values': [Group]
-}
-
-export type HirKindConcatVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Concat'
-  '@values': [Hir[]]
-}
-
-export type HirKindAlternationVariant = {
-  '@type': 'struct'
-  '@name': 'regex_syntax::hir::HirKind'
-  '@variant': 'Alternation'
-  '@values': [Hir[]]
-}
-
-
-
 export type Literal =
   | LiteralUnicodeVariant
   | LiteralByteVariant
@@ -270,6 +191,81 @@ export type RepetitionKindRangeVariant = {
 
 
 
+export type HirKind =
+  | HirKindEmptyVariant
+  | HirKindLiteralVariant
+  | HirKindClassVariant
+  | HirKindAnchorVariant
+  | HirKindWordBoundaryVariant
+  | HirKindRepetitionVariant
+  | HirKindGroupVariant
+  | HirKindConcatVariant
+  | HirKindAlternationVariant
+
+export type HirKindEmptyVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Empty'
+}
+
+export type HirKindLiteralVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Literal'
+  '@values': [Literal]
+}
+
+export type HirKindClassVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Class'
+  '@values': [Class]
+}
+
+export type HirKindAnchorVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Anchor'
+  '@values': [Anchor]
+}
+
+export type HirKindWordBoundaryVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'WordBoundary'
+  '@values': [WordBoundary]
+}
+
+export type HirKindRepetitionVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Repetition'
+  '@values': [Repetition]
+}
+
+export type HirKindGroupVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Group'
+  '@values': [Group]
+}
+
+export type HirKindConcatVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Concat'
+  '@values': [Hir[]]
+}
+
+export type HirKindAlternationVariant = {
+  '@type': 'struct'
+  '@name': 'regex_syntax::hir::HirKind'
+  '@variant': 'Alternation'
+  '@values': [Hir[]]
+}
+
+
+
 export type RepetitionRange =
   | RepetitionRangeExactlyVariant
   | RepetitionRangeAtLeastVariant
@@ -343,170 +339,118 @@ export type Match = {
 
 
 /**
-* A compiled regular expression for matching Unicode strings.
-* @see https://docs.rs/regex/latest/regex/
-*/
+ * A compiled regular expression for matching Unicode strings.
+ * @see https://docs.rs/regex/latest/regex/
+ */
 export class RRegex {
   free(): void;
-/**
-* 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: string);
-/**
-* 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.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match
-* @param {string} text
-* @returns {boolean}
-*/
-  isMatch(text: string): boolean;
-/**
-* 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`.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match_at
-* @param {string} text
-* @param {number} start
-* @returns {boolean}
-*/
+  /**
+   * 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`.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match_at
+   */
   isMatchAt(text: string, start: number): boolean;
-/**
-* 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`.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find
-* @param {string} text
-* @returns {any}
-*/
-  find(text: string): Match | undefined;
-/**
-* 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}
-*/
-  findAt(text: string, start: number): Match | undefined;
-/**
-* Returns an array for each successive non-overlapping match in text, returning the start and end byte indices with respect to text.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_iter
-* @param {string} text
-* @returns {any}
-*/
-  findAll(text: string): Match[];
-/**
-* 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.
-* If no match is found, then a copy of the string is returned unchanged.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace
-* @param {string} text
-* @param {string} rep
-* @returns {string}
-*/
-  replace(text: string, rep: string): 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
-* @returns {string}
-*/
-  replacen(text: string, limit: number, rep: string): string;
-/**
-* 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 https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace_all
-* @param {string} text
-* @param {string} rep
-* @returns {string}
-*/
+  /**
+   * 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 https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace_all
+   */
   replaceAll(text: string, rep: string): string;
-/**
-* 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.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.split
-* @param {string} text
-* @returns {any}
-*/
-  split(text: string): string[];
-/**
-* 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.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.splitn
-* @param {string} text
-* @param {number} limit
-* @returns {any}
-*/
-  splitn(text: string, limit: number): string[];
-/**
-* 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.
-* @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match
-* @param {string} text
-* @returns {number | undefined}
-*/
+  /**
+   * 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.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match
+   */
   shortestMatch(text: string): number | undefined;
-/**
-* 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}
-*/
+  /**
+   * 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
+   */
   shortestMatchAt(text: string, limit: number): number | undefined;
-/**
-* Return the Regex syntax object
-* @returns {any}
-*/
+  /**
+   * 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.
+   */
+  constructor(re: string);
+  /**
+   * 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`.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find
+   */
+  find(text: string): Match | undefined;
+  /**
+   * 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.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.split
+   */
+  split(text: string): string[];
+  /**
+   * 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.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.splitn
+   */
+  splitn(text: string, limit: number): string[];
+  /**
+   * Return the Regex syntax object
+   */
   syntax(): Hir;
-/**
-* Returns a string representing the regular expression
-* @returns {string}
-*/
+  /**
+   * 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
+   */
+  findAt(text: string, start: number): Match | undefined;
+  /**
+   * 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.
+   * If no match is found, then a copy of the string is returned unchanged.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace
+   */
+  replace(text: string, rep: string): string;
+  /**
+   * Returns an array for each successive non-overlapping match in text, returning the start and end byte indices with respect to text.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_iter
+   */
+  findAll(text: string): Match[];
+  /**
+   * 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.
+   * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match
+   */
+  isMatch(text: string): boolean;
+  /**
+   * 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
+   */
+  replacen(text: string, limit: number, rep: string): string;
+  /**
+   * Returns a string representing the regular expression
+   */
   toString(): string;
 }
 /**
-* 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.
-* @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.empty
-*/
+ * 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.
+ * @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.empty
+ */
 export class RRegexSet {
   free(): void;
-/**
-* Create a new regex set with the given regular expressions.
-* @param {Array<any>} list
-*/
+  /**
+   * Create a new regex set with the given regular expressions.
+   */
   constructor(list: Array<any>);
-/**
-* 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.
-* @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.is_match
-* @param {string} text
-* @returns {boolean}
-*/
-  isMatch(text: string): boolean;
-/**
-* 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}
-*/
+  /**
+   * 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.
+   */
   matches(text: string): any;
-}
-
-export const metadata: {
-  "name": "rregex",
-  "description": "Rust Regex binding for Javascript",
-  "authors": [
-    "Fede Ramirez <i@2fd.me>"
-  ],
-  "homepage": "https://2fd.github.io/rregex",
-  "repository": "https://github.com/2fd/rregex",
-  "regex": "1.2.1",
-  "regex-syntax": "0.6.25"
+  /**
+   * 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.
+   * @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.is_match
+   */
+  isMatch(text: string): boolean;
 }