Qusly-Core
[](https://travis-ci.org/qusly/qusly-core)
[](https://www.npmjs.com/package/qusly-core)
[](https://www.npmjs.com/package/qusly-core)
[](https://codecov.io/gh/qusly/qusly-core)
[](https://discord.gg/P7Vn4VX)
[](https://github.com/xnerhu)
Qusly-Core is a powerful multi-protocol library for file transfer. Created for [Qusly](https://github.com/qusly/qusly).
# Features
- Supports **FTP, FTPS, SFTP**
- [API that allows to call methods asynchronously](#tasksQueue)
- Informative transfer progress info - e.g. eta, speed in B/s
- [Connection pool](#connectionPool)
- Ability to register custom protocols
# Example
```js
import { Client } from 'qusly-core';
async function main() {
const client = new Client({ pool: 2 });
await client.connect({
protocol: 'ftp',
host: 'www.example.com',
user: 'root',
password: 'password',
});
// It will handle all methods at once.
const [documents, videos] = await Promise.all([
client.list('/documents'),
client.list('/videos'),
]);
console.log(document, videos);
await client.disconnect();
}
main();
```
# Installation
```bash
$ npm install qusly-core
```
# [Documentation](https://wexond.net/public/qusly/core/docs/index.html)
# [Roadmap](https://github.com/qusly/qusly-core/projects)
# Components
We use [ssh2](https://github.com/mscdex/ssh2) and [basic-ftp](https://github.com/patrickjuchli/basic-ftp) under the hood.
