PathCompatibilityViolation
One thing wrong with one path, and the platform that objects to it.
Import:
import type { PathCompatibilityViolation } from '@mnaoumov/obsidian-lib/path-compatibility';Signature:
export interface PathCompatibilityViolationProperties
| Property | Type | Description |
|---|---|---|
| characters? | readonly string[] | The offending characters, each once, in the order they first appear in the name. Set for PathCompatibilityViolationType.ForbiddenCharacter and PathCompatibilityViolationType.ObsidianForbiddenCharacter, so the report can name them. |
| measurement? | PathCompatibilityMeasurement | What was measured and the limit it was measured against. Set for PathCompatibilityViolationType.NameTooLong and PathCompatibilityViolationType.PathTooLong, so a reader of the report can verify the verdict. |
| platform | null | PathCompatibilityPlatform | The platform whose rules the path breaks. Another enabled platform may accept the very same path.null for a violation no single platform owns, which is PathCompatibilityViolationType.ObsidianForbiddenCharacter and PathCompatibilityViolationType.UnicodeNotNormalized. |
| type | PathCompatibilityViolationType | What is wrong. |
Links to this page: