New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation May Be Wrong #302

Open

joshuafrost opened this issue Jul 12, 2019 · 1 comment

joshuafrost commented Jul 12, 2019

On your how to / api example it reads:

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

Did you mean Ftp? What is Ffp?

Nico-TH commented Aug 2, 2019 •

edited

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...).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment