Skip to content

ReplaceAllAsyncParams<ReplaceGroupArguments>

Parameters for replaceAllAsync.

Import:

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

Signature:

export interface ReplaceAllAsyncParams<ReplaceGroupArguments extends string[]>

Properties

PropertyTypeDescription
$stringstringThe string in which to perform replacements.
abortSignal?AbortSignalThe abort signal to control the execution of the function.
replacerAsyncReplacer<ReplaceGroupArguments>A synchronous/asynchronous function that generates replacement strings, or a string to replace with.
searchValueRegExp | stringThe string or regular expression to search for.

Links to this page: