ReplaceArgs<CapturedGroupArgs>

Common arguments for the replaceAll/replaceAllAsync functions.

Import:

import type { ReplaceArgs } from 'obsidian-dev-utils/string';

Signature:

export interface ReplaceArgs<CapturedGroupArgs extends string[]>

Properties

Property	Type	Description
capturedGroupArgs	CapturedGroupArgs	Captured group arguments.
groups	Record<string, string | undefined> | undefined	Groups of the match.
missingGroupIndices	number[]	Indices of the groups that were not found in the match.
offset	number	An offset of the match.
source	string	A source of the match.
substring	string	A substring of the match.

---

Links to this page:

• AsyncReplacer
• Replacer