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

    Interface Options

    Configuration options for filesystem operations.

    interface Options {
        includeSystemVolumes: boolean;
        linuxMountTablePaths: string[];
        maxConcurrency: number;
        mountPoints?: MountPoint[];
        networkFsTypes: string[];
        skipNetworkVolumes: boolean;
        systemFsTypes: string[];
        systemPathPatterns: string[];
        timeoutMs: number;
    }
    Index

    Properties

    includeSystemVolumes: boolean

    Should system volumes be included in result arrays? Defaults to true on Windows and false elsewhere.

    linuxMountTablePaths: string[]

    On Linux, use the first mount point table in this array that is readable.

    LinuxMountTablePathsDefault for the default values

    maxConcurrency: number

    Maximum number of concurrent filesystem operations.

    Defaults to availableParallelism.

    mountPoints?: MountPoint[]

    Pre-fetched mount points to use instead of querying the system.

    When provided, functions like getMountPointForPath and getVolumeMetadataForPath will use these mount points for device ID matching instead of calling getVolumeMountPoints internally. This avoids redundant system queries when resolving multiple paths.

    Obtain via getVolumeMountPoints({ includeSystemVolumes: true }) — system volumes must be included for device ID matching to work correctly.

    networkFsTypes: string[]

    Filesystem types that indicate network/remote volumes.

    NetworkFsTypesDefault for the default value

    skipNetworkVolumes: boolean

    Skip detailed info for network volumes to avoid blocking. Defaults to false.

    systemFsTypes: string[]

    On Linux and macOS, volumes whose filesystem matches any of these strings will have MountPoint.isSystemVolume set to true.

    SystemFsTypesDefault for the default value

    systemPathPatterns: string[]

    On Linux and macOS, mount point pathnames that matches any of these glob patterns will have MountPoint.isSystemVolume set to true.

    SystemPathPatternsDefault for the default value

    timeoutMs: number

    Timeout in milliseconds for filesystem operations.

    Disable timeouts by setting this to 0.