RepairNameParams
Parameters for repairName.
Import:
import type { RepairNameParams } from '@mnaoumov/obsidian-lib/path-compatibility';Signature:
export interface RepairNameParamsProperties
| Property | Type | Description |
|---|---|---|
| basename | string | The name without its extension. For a folder, the whole name. |
| extension | string | The name's extension, without the leading dot. Empty for a folder or an extension-less file. |
| forbiddenCharacterReplacement | string | What each forbidden character is replaced with. Empty deletes it. Must pass getForbiddenCharacterReplacementValidationMessage, or the repair would put back what it removed. |
| isFolder | boolean | Whether the name belongs to a folder. |
| maxVaultRootPathLength | number | The length of the longest vault root path the vault is expected to live under, in characters. |
| parentPath | string | The vault-relative path of the parent folder. Empty at the vault root. |
| platforms | readonly PathCompatibilityPlatform[] | The platforms whose rules the repaired name must satisfy. |
Links to this page: