RegexFind constructor

RegexFind({
  1. @required dynamic input,
  2. @required dynamic regex,
  3. dynamic options,
})

Creates $regexFind operator expression

Provides regular expression (regex) pattern matching capability in aggregation expressions. If a match is found, returns a document that contains information on the first match. If a match is not found, returns null.

MongoDB uses Perl compatible regular expressions (i.e. “PCRE” ) version 8.41 with UTF-8 support.

  • input - The string on which you wish to apply the regex pattern. Can be a string or any valid expression that resolves to a string.
  • regex - The regex pattern to apply. Can be any valid expression that resolves to a string.
  • options - Optional. The following

Implementation

RegexFind({@required input, @required regex, options})
    : super('regexFind',
          AEObject({'input': input, 'regex': regex, 'options': options}));