Interface ArchiveNoteArgs

Arguments for archiveNote.

Thin wrapper around rename — moves a note into the archive folder while preserving every wikilink and embed that points at it.

interface ArchiveNoteArgs {
    archive_folder?: string;
    dry_run?: boolean;
    overwrite?: boolean;
    path: string;
}

Properties

archive_folder?: string

Archive folder. Defaults to Archive/. Trailing slash optional.

dry_run?: boolean

Preview the rewrite plan without writing. Default false.

overwrite?: boolean

Allow overwriting an existing file at the archive destination. Default false.

path: string

Vault-relative path of the note to archive (with or without .md).