Skip to content

RegisterVirtualFileParams

Parameters for registerVirtualFile.

Import:

import type { RegisterVirtualFileParams } from '@mnaoumov/obsidian-lib/virtual-file';

Signature:

export interface RegisterVirtualFileParams

Properties

PropertyTypeDescription
appAppThe app whose resolver and read methods serve the file.
contentstringImmutable UTF-8 text, also available synchronously on the registration.
pathstringUnoccupied vault-relative file path in an existing folder.

Links to this page: