FindPathCompatibilityViolationsParams
Parameters for findPathCompatibilityViolations.
Import:
import type { FindPathCompatibilityViolationsParams } from '@mnaoumov/obsidian-lib/path-compatibility';Signature:
export interface FindPathCompatibilityViolationsParamsProperties
| Property | Type | Description |
|---|---|---|
| isFolder | boolean | Whether the path names a folder, which has its own path budget. |
| maxVaultRootPathLength | number | The length of the longest vault root path the vault is expected to live under, in characters. The vault root of a platform the check is not running on is unknowable, so it is stated rather than guessed — see the maxVaultRootPathLength setting. |
| path | string | The vault-relative path to check. |
| platforms | readonly PathCompatibilityPlatform[] | The platforms whose rules to enforce. |
Links to this page: