@photostructure/fs-metadata
    Preparing search index...

    Interface MountPoint

    A mount point is a location in the file system where a volume is mounted.

    interface MountPoint {
        error?: string | Error;
        fstype?: string;
        isReadOnly?: boolean;
        isSystemVolume?: boolean;
        mountPoint: string;
        status?: string;
        volumeRole?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    error?: string | Error

    If there are non-critical errors while extracting metadata, those errors may be added to this field.

    fstype?: string

    The type of file system on the volume, like ext4, apfs, or ntfs.

    Note: on Windows this may show as "ntfs" for remote filesystems, as that is how the filesystem is presented to the OS.

    isReadOnly?: boolean

    Whether the volume is mounted read-only.

    Examples of read-only volumes include the macOS APFS system snapshot at /, mounted ISO images, and write-protected media.

    Note that the macOS root volume (/) UUID changes on every OS update, so consumers should avoid using it for persistent identification.

    isSystemVolume?: boolean

    Indicates if this volume is primarily for system use (e.g., swap, snap loopbacks, EFI boot, or only system directories).

    On macOS, the sealed APFS system snapshot at / is detected natively via MNT_SNAPSHOT; other infrastructure volumes under /System/Volumes/* are detected via APFS volume roles (IOKit). Note that /System/Volumes/Data is not a system volume — it holds all user data, accessed via firmlinks.

    mountPoint: string

    Mount location (like "/" or "C:").

    status?: string

    On Windows, returns the health status of the volume.

    Note that this is only available on Windows, as both Linux and macOS are prohibitively expensive, requiring forking fsck -N or diskutil verifyVolume.

    If there are non-critical errors while extracting metadata, those error messages may be added to this field (say, from blkid or gio).

    VolumeHealthStatuses for values returned by Windows.

    volumeRole?: string

    The APFS volume role, if available. Only present on macOS for APFS volumes.

    Common roles: "System", "Data", "VM", "Preboot", "Recovery", "Update", "Hardware", "xART", "Prelogin", "Backup".

    Used for system volume detection: volumes with a non-"Data" role and MNT_DONTBROWSE are classified as system volumes.