Skip to content

GetAvailablePathForAttachmentsParams

Options for the getAvailablePathForAttachments function.

Import:

import type { GetAvailablePathForAttachmentsParams } from 'obsidian-dev-utils/obsidian/attachment-path';

Signature:

export interface GetAvailablePathForAttachmentsParams

Properties

PropertyTypeDescription
appAppAn Obsidian application instance.
attachmentFileBaseNamestringA base name of the attachment.
attachmentFileExtensionstringAn extension of the attachment.
notePathOrFilenull | PathOrFileA file to attach to.
shouldSkipDuplicateCheck?booleanShould the duplicate check be skipped.
shouldSkipMissingAttachmentFolderCreation?booleanShould missing attachment folder creation be skipped.

Links to this page: