Skip to content

getFile

Retrieves a file based on the provided path or file.

Import:

import { getFile } from 'obsidian-dev-utils/obsidian/file-system';

Signature:

function getFile(params: GetFileParams): TFile

Parameters:

ParameterTypeDescription
paramsGetFileParamsThe parameters for the retrieval.

Returns: TFile — The file corresponding to the provided path or file.


Links to this page: