Create / Resize sparse file
- Support Linux / MacOS
- Default Safe Mode
- Not Affected By System Cache
- Get Physical Size(the space that a file takes up on disk)
- 100% Code Coverage
- 0 Dependency
# npm
npm install @oomol-lab/sparse-file
# yarn
yarn add @oomol-lab/sparse-file
# pnpm
pnpm add @oomol-lab/sparse-file
filepath
: string - Sparse file paths to create/resizesize
: number - Sparse file sizeoptions?.safe
: boolean - Safe mode, default: trueoptions?.mode
: number - File mode. By default, the mode is only set when creating a file, unless overwriteMode is specified. default: 0o644options?.overwriteMode
: boolean - Overwrite mode. When the overwrite mode is allowed, the mode will be set even if the file exists. default: false
In safe mode, an error will occur if the size is less than 0 or greater than Number.MAX_SAFE_INTEGER
. Additionally, it will be rejected if the passed size is larger than the current file size.
In non-safe mode, a size less than 0 will be reset to 0, and a size greater than Number.MAX_SAFE_INTEGER
will be reset to Number.MAX_SAFE_INTEGER
.
alias to: createSparse
filepath
: string - File paths
Return the actual occupied size of the file on the physical hard drive.