Skip to content

RepairNameParams

Parameters for repairName.

Import:

import type { RepairNameParams } from '@mnaoumov/obsidian-lib/path-compatibility';

Signature:

export interface RepairNameParams

Properties

PropertyTypeDescription
basenamestringThe name without its extension. For a folder, the whole name.
extensionstringThe name's extension, without the leading dot. Empty for a folder or an extension-less file.
forbiddenCharacterReplacementstringWhat each forbidden character is replaced with. Empty deletes it. Must pass getForbiddenCharacterReplacementValidationMessage, or the repair would put back what it removed.
isFolderbooleanWhether the name belongs to a folder.
maxVaultRootPathLengthnumberThe length of the longest vault root path the vault is expected to live under, in characters.
parentPathstringThe vault-relative path of the parent folder. Empty at the vault root.
platformsreadonly PathCompatibilityPlatform[]The platforms whose rules the repaired name must satisfy.

Links to this page: