# fs-ftp-ts

> FTP Client in TypeScript

Latest version **0.1.0** (published 2019-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install fs-ftp-ts
pnpm add fs-ftp-ts
yarn add fs-ftp-ts
bun add fs-ftp-ts
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-09-14 |
| First published | 2019-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 291.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Konrad Kuznicki |
| Maintainers | konradk2 |
| Keywords | ftp, ftp client, TypeScript, ftp-client |

## Links

- npm: https://www.npmjs.com/package/fs-ftp-ts
- Repository: https://github.com/KonradKuznicki/fs-ftp-ts
- Homepage: https://github.com/KonradKuznicki/fs-ftp-ts#readme
- Issues: https://github.com/KonradKuznicki/fs-ftp-ts/issues
- npm.io page: https://npm.io/package/fs-ftp-ts

## Dependencies (3)

- [ftp](https://npm.io/package/ftp.md) ^0.3.10
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2019-09-14
- 0.0.4 — 2019-09-14
- 0.0.3 — 2019-09-14
- 0.0.2 — 2019-09-14
- 0.0.1 — 2019-09-14

## README

# WARNING: work in progress

To get something working for the first version I used [node-ftp](https://github.com/mscdex/node-ftp) 

But this project is not maintained for last 4 years so I plan to rewrite it and fix bugs

I have to also research [ftp-ts](https://github.com/lumphe/ftp-ts)

# FTP Client in TypeScript 
[![Coverage Status](https://coveralls.io/repos/github/KonradKuznicki/ftp-ts/badge.svg?branch=master)](https://coveralls.io/github/KonradKuznicki/ftp-ts?branch=master) [![CircleCI](https://circleci.com/gh/KonradKuznicki/ftp-ts.svg?style=svg)](https://circleci.com/gh/KonradKuznicki/ftp-ts)

This client is focused on ease of usage 
 
With Promises and automatic connection management all you need to do is

```JavaScript
const fsFtpTs = require("fs-ftp-ts");
(async () => {

    const list = await fsFtpTs.readdir('ftp://speedtest.tele2.net/');
    
    console.log(list.map(i => i.name));

    const file = await fsFtpTs.readFile('ftp://demo:password@test.rebex.net/readme.txt');
    
    console.log(file.toString('utf8'));

})();
```

I also try to keep API similar to Node.js File System API

# Tests 
`$ yarn run test:all`

## Unit tests
`$ yarn run test`

## End 2 End tests with real ftp server [ftp-srv](https://github.com/trs/ftp-srv) 
_This server does not provide me with weird errors 
<br> that I experience on the web with node-ftp
<br> but I hope to emulate them._
 
`$ yarn run test:e2e`

---
_Source: https://npm.io/package/fs-ftp-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._