Interface VolumeMetadata

Metadata associated to a volume.

interface VolumeMetadata {
    available: number;
    fileSystem?: string;
    label?: string;
    mountPoint: string;
    ok?: boolean;
    remote?: boolean;
    remoteHost?: string;
    remoteShare?: string;
    size: number;
    status?: string;
    used: number;
    uuid?: string;
}

Properties

available fileSystem? label? mountPoint ok? remote? remoteHost? remoteShare? size status? used uuid?

Properties

available

available: number

Available size in bytes

OptionalfileSystem

fileSystem?: string

This is the file system type (like "ext4" or "apfs")

Optionallabel

label?: string

The name of the partition

mountPoint

mountPoint: string

Mount location (like "/home" or "C:"). May be a unique key at any given time, unless there are file system shenanigans (like from mergefs)

Optionalok

ok?: boolean

We may be able to tell if a mountpoint is "Connected and OK", "degraded", "disconnected", or otherwise unknown.

Optionalremote

remote?: boolean

Remote/network volume?

OptionalremoteHost

remoteHost?: string

If remote, the ip or hostname hosting the share (like "rusty" or "10.1.1.3")

OptionalremoteShare

remoteShare?: string

If remote, the name of the share (like "homes")

size

size: number

Total size in bytes

Optionalstatus

status?: string

May be set if !ok

used

used: number

Used size in bytes

Optionaluuid

uuid?: string

UUID for the volume, like "d46edc85-a030-4dd7-a2a8-68344034e27d".

Settings

Member Visibility

On This Page

Properties