WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

RegExp-Treffer: `index` und `groups`

Lies den Start des gesamten Treffers und den Text benannter Gruppen aus. Mit dem Flag `d` erhältst du zusätzlich Start- und Endpositionen.

Version: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

const m = re.exec(text); // Match array or null
// After checking m !== null:
m.index;            // Start of the full match
m[0];               // Full matched text
m[1];               // First capture, if present
m.groups?.name;     // Text from (?<name>...) if it matched
m.indices?.[0];     // Full match range with the d flag
m.indices?.groups?.name; // Named capture range with the d flag

re.exec(text) gibt ein Treffer-Array oder bei keinem Treffer null zurück. Prüfe vor dem Zugriff auf Eigenschaften, ob das Ergebnis null ist. Im Array m steht in m[0] der gesamte Treffer. Ab m[1] folgen die erfassten Texte, auch die benannter Gruppen, in der Reihenfolge der öffnenden Klammern. m.input enthält den gesamten Eingabestring.

m.index ist die nullbasierte Startposition des gesamten Treffers in UTF-16-Codeeinheiten, auch mit dem Flag u. Sie ist weder eine Gruppennummer noch re.lastIndex: Bei g oder y speichert der reguläre Ausdruck in lastIndex die Position, an der der nächste exec()-Aufruf ansetzt.

Bei (?<name>...) steht der erfasste Text in m.groups.name. Ohne benannte Gruppen ist m.groups gleich undefined; andernfalls ist es ein Objekt ohne Prototyp. Hat eine Gruppe am Treffer nicht mitgewirkt, ist ihr Wert undefined und nicht der leere String "".

Das Flag d ergänzt m.indices: m.indices[0] ist der Bereich des gesamten Treffers, m.indices[1] der Bereich der ersten erfassenden Gruppe und m.indices.groups.name der Bereich der benannten Gruppe. Jedes vorhandene Paar [start, end] verwendet UTF-16-Positionen und schließt end aus. Es passt daher direkt zu text.slice(start, end). Hat die Gruppe nicht mitgewirkt, steht statt des Paars undefined; ohne d fehlt die Eigenschaft m.indices. Prüfe, ob deine Zielumgebung d und benannte Gruppen unterstützt.

Mit einem standardmäßigen RegExp liefert text.match(re) ohne g dieselbe Art von Ergebnis wie exec(). Mit g liefert es nur die vollständigen Treffertexte oder null, ohne Metadaten pro Treffer. Um diese Metadaten zu erhalten, iteriere mit gesetztem g über text.matchAll(re). Der Iterator verwendet eine Kopie des regulären Ausdrucks, die den aktuellen Wert von re.lastIndex übernimmt. Bei einem wiederverwendeten Ausdruck mit einem lastIndex ungleich null können daher frühere Treffer übersprungen werden. Um von Anfang an zu suchen, verwende einen neuen regulären Ausdruck oder setze re.lastIndex = 0, bevor du matchAll() aufrufst. Ein RegExp ohne g löst dabei einen TypeError aus.

Beispiele

(() => {
  const text = "😀 id=42";
  const m = /id=(?<id>\d+)(?<unit>ms)?/du.exec(text);
  if (m === null) throw new Error("Expected a match");

  const [start, end] = m.indices.groups.id;
  console.log(JSON.stringify({
    match: m[0],
    index: m.index,
    id: m.groups.id,
    idRange: [start, end],
    slicedId: text.slice(start, end),
    unitMissing: m.groups.unit === undefined
  }));
})();

Ergebnis

{"match":"id=42","index":3,"id":"42","idRange":[6,8],"slicedId":"42","unitMissing":true}

Das Emoji belegt zwei UTF-16-Codeeinheiten, das Leerzeichen eine. Deshalb beginnt `id=42` bei `3`. Die Gruppe `id` erfasst den String `"42"` aus `[6, 8]`; die optionale Gruppe `unit` wirkt am Treffer nicht mit.

Zugehörige Lektionen

  • JavaScript · Lektion 25 · Mittlere Stufe · Version: 3

Quellen