# fs-slicer

**Repository Path**: npm-packages/fs-slicer

## Basic Information

- **Project Name**: fs-slicer
- **Description**: Read chunk from file or join files from blocks tool.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-05-27
- **Last Updated**: 2023-05-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# file-slice

Read chunk from file or join files from blocks tool.


## Install
```bash
npm i fs-slicer --save
```


## Example
```javascript
const fileSlice = require("fs-slicer");
async function test() {
  const sourFilePath = "a.exe";
  const distFilePath = "./tmp/b.exe";
  const buffInfoArray = fileSlice.getSliceInfoArr(sourFilePath);
  console.log(buffInfoArray);
  const blockArr = [];
  for (const info of buffInfoArray) {
    const buf=await fileSlice.readOneBlock(sourFilePath, info);
    blockArr.push(buf);
  }
  await fileSlice.joinBlcoksToFile(distFilePath,blockArr);
}
test().then(()=>{});
```


### APIs

```javascript
    //get slice info but not real slice
    getSliceInfoArr(sourFilePath):Array[{start:number,end:number}];

    //read a block from file
    readOneBlock(sourFilePath, info):Promise<Buffer>;
    
    //join a file from blocks
    joinBlcoksToFile(distFilePath,blockArr):Promise<void>;
    
```