Skip to content

Include step-by-step to connect using your properties #252

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

Open
estevamdf2 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Include step-by-step to connect using your properties #252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,35 @@ Examples
c.connect();
```

* Using your properties connections


```javascript
var Client = require('ftp');
var fs = require('fs');

var config = {
host: 'my-host',
port: 'my-port',
user: 'my-user',
password: 'my-password',
};
var options = {
logging: 'basic'
};
var c = new Client();

c.on('ready', function() {
c.list(function(err, list) {
if (err) throw err;
console.dir(list);
c.end();
});
});
// your properties of connection
c.connect(config,options);

```
API
===

Expand Down Expand Up @@ -139,7 +167,7 @@ Methods
* group - _string_ - An empty string or any combination of 'r', 'w', 'x'.

* other - _string_ - An empty string or any combination of 'r', 'w', 'x'.

* owner - _string_ - The user name or ID that this entry belongs to **(*NIX only)**.

* group - _string_ - The group name or ID that this entry belongs to **(*NIX only)**.
Expand Down