tabshift/ftp-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(readme): correct word and improve events (#91)

Browse Source
This commit is contained in:
Diego Rodríguez Baquero
2018-06-02 13:48:39 -05:00
committed by Tyler Stewart
parent 58b9ba27d9
commit 442490d713
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -177,7 +177,7 @@ The `FtpSrv` class extends the [node net.Server](https://nodejs.org/api/net.html
### `login`
```js
on('login', ({connection, username, password}, resolve, reject) => { ... });
ftpServer.on('login', ({connection, username, password}, resolve, reject) => { ... });
```
Occurs when a client is attempting to login. Here you can resolve the login request by username and password.
@@ -204,7 +204,7 @@ Occurs when a client is attempting to login. Here you can resolve the login requ
### `client-error`
```js
on('client-error', ({connection, context, error}) => { ... });
ftpServer.on('client-error', ({connection, context, error}) => { ... });
```
Occurs when an error arises in the client connection.
@@ -215,7 +215,7 @@ Occurs when an error arises in the client connection.
### `RETR`
```js
on('RETR', (error, filePath) => { ... });
connection.on('RETR', (error, filePath) => { ... });
```
Occurs when a file is downloaded.
@@ -225,13 +225,13 @@ Occurs when a file is downloaded.
### `STOR`
```js
on('STOR', (error, fileName) => { ... });
connection.on('STOR', (error, fileName) => { ... });
```
Occurs when a file is uploaded.
`error` if successful, will be `null`
`fileName` name of the file that was downloaded
`fileName` name of the file that was uploaded
## Supported Commands