jsftp icon indicating copy to clipboard operation
jsftp copied to clipboard

Documentation May Be Wrong

Open joshuafrost opened this issue 6 years ago • 1 comments

On your how to / api example it reads:

const ftp = new Ffp({ host: 'localhost', port: 3333, ....

Did you mean Ftp? What is Ffp?

joshuafrost avatar Jul 12 '19 15:07 joshuafrost

It's the imported module's name.

If you import as in "Starting it up" : const jsftp = require("jsftp");

It should be : const ftp = new jsftp({ host: 'localhost', port: 3333, ....

Maybe the documention should be updated to use the module name 'jsftp' everywhere instead of 'Ffp' (or the contrary...).

Nico-TH avatar Aug 02 '19 10:08 Nico-TH