Skip to content

LockResourceForPathParams

Parameters for lockResourceForPath.

Import:

import type { LockResourceForPathParams } from 'obsidian-dev-utils/obsidian/resource-lock';

Signature:

export interface LockResourceForPathParams

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
operationNamestringA human-readable name of the operation taking the lock (e.g. 'Move selection'). Shown next to the plugin name in the unlock confirmation dialog.
pathOrFilePathOrFileThe path or file of the note to lock.
pluginIdstringThe id of the locking plugin (e.g. its manifest.id). The lock is attributed to it for reference-counting and the indicators' "locked by" tooltip.

Links to this page: