-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: update options type imports and create a new options type d…
…efinition file
- Loading branch information
Showing
9 changed files
with
67 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
// src/types/options.ts | ||
|
||
/** | ||
* Configuration options for filesystem operations. | ||
* | ||
* @see {@link optionsWithDefaults} for creating an options object with default values | ||
* @see {@link OptionsDefault} for the default values | ||
*/ | ||
export interface Options { | ||
/** | ||
* Timeout in milliseconds for filesystem operations. | ||
* | ||
* Disable timeouts by setting this to 0. | ||
* | ||
* @see {@link TimeoutMsDefault}. | ||
*/ | ||
timeoutMs: number; | ||
|
||
/** | ||
* Maximum number of concurrent filesystem operations. | ||
* | ||
* Defaults to {@link https://nodejs.org/api/os.html#osavailableparallelism | availableParallelism}. | ||
*/ | ||
maxConcurrency: number; | ||
|
||
/** | ||
* On Linux and macOS, mount point pathnames that matches any of these glob | ||
* patterns will have {@link MountPoint.isSystemVolume} set to true. | ||
* | ||
* @see {@link SystemPathPatternsDefault} for the default value | ||
*/ | ||
systemPathPatterns: string[]; | ||
|
||
/** | ||
* On Linux and macOS, volumes whose filesystem matches any of these strings | ||
* will have {@link MountPoint.isSystemVolume} set to true. | ||
* | ||
* @see {@link SystemFsTypesDefault} for the default value | ||
*/ | ||
systemFsTypes: string[]; | ||
|
||
/** | ||
* On Linux, use the first mount point table in this array that is readable. | ||
* | ||
* @see {@link LinuxMountTablePathsDefault} for the default values | ||
*/ | ||
linuxMountTablePaths: string[]; | ||
|
||
/** | ||
* Should system volumes be included in result arrays? Defaults to true on | ||
* Windows and false elsewhere. | ||
*/ | ||
includeSystemVolumes: boolean; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters