A collection of utility functions for handling files, such as split big file or
merge multiple small files.
## Install
* npm
```bash
npm install --save @guanghechen/helper-file
```
* yarn
```bash
yarn add @guanghechen/helper-file
```
## Usage
* `BigFileHelper` (inspired by [split-file][])
```typescript
import { bigFileHelper, calcFilePartItemsBySize } from '@guanghechen/helper-file'
async function splitFile(filepath: string): Promise {
const parts = calcFilePartItemsBySize(filepath, 1024 * 1024 * 80) // 80MB per chunk
const partFilepaths: string[] = await bigFileHelper.split(filepath, parts)
return partFilepaths
}
splitFile('big-file.txt')
```
### Overview
Name | Description
:----------------------------------:|:----------------------------:
`BigFileHelper` | A utility class for split / merging big files
`bigFileHelper` | Default instance of `BigFleHelper`
`calcFilePartItemsBySize` | Generate file part items by part size
`calcFilePartItemsByCount` | Generate file part items by total of parts
`calcFilePartNames` | Generate file part names (suffix)
[homepage]: https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/helper-file@5.0.7/packages/helper-file#readme
[split-file]: https://github.com/tomvlk/node-split-file
