Interface Options

Configuration options for filesystem operations.

See

interface Options {
    includeSystemVolumes: boolean;
    linuxMountTablePaths: string[];
    maxConcurrency: number;
    systemFsTypes: Set<string>;
    systemPathPatterns: string[];
    timeoutMs: number;
}

Properties

includeSystemVolumes linuxMountTablePaths maxConcurrency systemFsTypes systemPathPatterns timeoutMs

Properties

includeSystemVolumes

includeSystemVolumes: boolean

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

linuxMountTablePaths

linuxMountTablePaths: string[]

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

See

LinuxMountTablePathsDefault for the default values

maxConcurrency

maxConcurrency: number

Maximum number of concurrent filesystem operations.

Defaults to availableParallelism.

systemFsTypes

systemFsTypes: Set<string>

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

See

SystemFsTypesDefault for the default value

systemPathPatterns

systemPathPatterns: string[]

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

See

SystemPathPatternsDefault for the default value

timeoutMs

timeoutMs: number

Timeout in milliseconds for filesystem operations.

Disable timeouts by setting this to 0.

See

TimeoutMsDefault.

Settings

Member Visibility

On This Page

Properties