https://github.com/alpheustangs/filego.js

A file splitting & merging solution
https://github.com/alpheustangs/filego.js

check filego filesystem javascript merge split typescript

Last synced: 30 days ago
JSON representation

A file splitting & merging solution

• Host: GitHub
• URL: https://github.com/alpheustangs/filego.js
• Owner: alpheustangs
• License: mit
• Created: 2024-05-09T13:35:03.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T12:59:59.000Z (2 months ago)
• Last Synced: 2024-10-29T14:58:32.522Z (2 months ago)
• Topics: check, filego, filesystem, javascript, merge, split, typescript
• Language: TypeScript
• Homepage:
• Size: 4.94 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FileGo

A file splitting & merging solution.

## Installation

For JavaScript/TypeScript environment:

```sh

# npm

npm i @filego/js

# Yarn

yarn add @filego/js

# pnpm

pnpm add @filego/js

```

For Node environment:

```sh

# npm

npm i @filego/node

# Yarn

yarn add @filego/node

# pnpm

pnpm add @filego/node

```

## Quick Start

Split file from a path to a directory directly with `split` function in `@filego/node`.

```ts

import { split } from "@filego/node";

await split({

    inFile: "/path/to/file.txt",

    outDir: "/path/to/dir",

    chunkSize: 2 * 1024 * 1024,

});

```

## Documentation

For the usage of `@filego/js`, please refer to the [JS documentation](./docs/js/README.md).

For the usage of `@filego/node`, please refer to the [Node documentation](./docs/node/README.md).

## Examples

Check out the Web and API examples:

For the example of web in React, please refer to [examples/web](./examples/web/).

For the example of Node in Fastify, please refer to [examples/node](./examples/node/).

## License

This project is licensed under the terms of the MIT license.