MatchRegex

Deprecated. Use the **MatchRegexV2** script instead.

Type
javascript
Pack
CommonScripts

Source

var data = (typeof args.data) === 'string' ? args.data : JSON.stringify(args.data);
var flags = args.flags ? args.flags : 'gim';
var r = new RegExp(args.regex, flags);
var m;
var vals = [];
while ((m = r.exec(data)) !== null) {
    if (m && m.length > 0) {
        var val = m[0];
        var group = parseInt(args.group);
        if (args.group && m.length > group) {
            val = m[group];
        }
        var ec = {};
        if (args.contextKey) {
            ec[args.contextKey] = val;
        }
        vals.push(val);

        if (flags.indexOf('g') === -1) {
          break;
        }
    }
}
if (vals.length == 1) {
  setContext('MatchRegex.results', vals[0])
  return {Type: entryTypes.note, Contents: vals[0], ContentsFormat: formats.text, EntryContext: ec};
} else if (vals.length) {
  setContext('MatchRegex.results', vals)
  return {Type: entryTypes.note, Contents: vals, ContentsFormat: formats.text, EntryContext: ec};
} else {
  setContext('MatchRegex.results', vals)
  return {Type: entryTypes.note, Contents: 'Regex does not match', ContentsFormat: formats.text};
}

README

Deprecated. Use the MatchRegexV2 script instead.
Extracts regex data from a given text. The script supports groups and looping.

Script Data

Name Description
Script Type javascript
Tags Utility

Inputs

Argument Name Description
data The text date from which to extract the regex.
regex The regex to match and extract.
group The matching group to return. If no group is provided, the full match will be returned. The group value should start at 1.
contextKey The context key to populate with the result.
flags The regex flags to match. The default is “-gim”.

Outputs

Path Description Type
MatchRegex.results List of regex matches. string