Skip to content

ApplyFileChangesParams

Parameters for applyFileChanges.

Import:

import type { ApplyFileChangesParams } from 'obsidian-dev-utils/obsidian/file-change';

Signature:

export interface ApplyFileChangesParams extends ApplyFileChangesOptions

Extends: ApplyFileChangesOptions

Properties

PropertyTypeDescription
appAppThe application instance where the file changes will be applied.
changesProviderValueProvider<FileChange[] | null, ContentArgs>A provider that returns an array of file changes to apply.
pathOrFilePathOrFileThe path or file to which the changes should be applied.
shouldRetryOnInvalidChanges?booleanWhether to retry the operation if the changes are invalid.

Links to this page: