Skip to content

BulkOperationCommitComponentConstructorParams

Constructor parameters for BulkOperationCommitComponent.

Import:

import type { BulkOperationCommitComponentConstructorParams } from '@mnaoumov/obsidian-lib/components/bulk-operation-commit-component';

Signature:

export interface BulkOperationCommitComponentConstructorParams

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
isEnabled() => booleanWhether the plugin's opt-in setting for bulk-operation commits is on. Read on every operation, so a settings change applies to the next one.
maxSettleTimeInMilliseconds?numberThe longest the settle step waits for the vault to go quiet after an operation.
pluginIdstringThe id of the plugin whose operations are committed.
pluginNoticeComponentPluginNoticeComponentThe notice component used to report problems.
quietPeriodInMilliseconds?numberHow long the vault must go without a change after an operation before its commit is made.