new ftpdjs(options)
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object |
- Since:
- 0.6.0
- Source:
Methods
getOptions() → {Object}
- Since:
- 0.6.0
- Source:
Returns:
the options Object for ftpd.js
- Type
- Object
getPackage() → {Object}
- Since:
- 0.6.0
- Source:
Returns:
the package.json for ftpd.js
- Type
- Object
log(message, callback)
This function is used to log messages to the attached stream
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string | the message to log |
callback |
ftpdjs~logCallback | the callback to invoke when finished logging or an error occoured. Optional |
- Since:
- 0.6.0
- Source:
setup()
This function is used to tell ftpdjs to start setting up
- Since:
- 0.6.0
- Source:
setupServer(options, callback)
This function is used to setup a new server from the options provided
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object | the server options |
callback |
ftpdjs~didSetupServer | the callback to invoke when the server have finished setting up |
- Since:
- 0.6.0
- Source:
Type Definitions
didSetupServer(the)
This callback is used when a server have been setup
Parameters:
| Name | Type | Description |
|---|---|---|
the |
Server | server that finished setting up |
- Since:
- 0.6.0
- Source:
logCallback(error)
Parameters:
| Name | Type | Description |
|---|---|---|
error |
Object | the error if one occoured |
- Since:
- 0.6.0
- Source: