@cumulus/sftp-client
Advanced tools
A Promise-based SFTP client
npm install @cumulus/sftp-client
const { SftpClient } = require("@cumulus/sftp-client");
(async () => {
const sftpClient = new SftpClient({
host: "ssh.example.com",
port: 2222,
username: "my-username",
password: "my-password"
});
console.log(await sftpClient.list("./"));
})();
Type: object
Type: string
The hostname or IP address of the remote SFTP server.
Type: number
Default: 22
The TCP port to connect to.
Type: string
The username to use when connecting to the SFTP server.
Type: string
The password to use when connecting to the SFTP server.
Type: string
A private key to use when connecting to the SFTP server.
Download a remote file to disk. Returns a Promise that resolves to a string
containing the local path that the file was saved to.
Type: string
The full path to the remote file to be fetched
Type: string
The full local destination file path
Close the connect to the SFTP server.
Returns a Promise that resolves to an array of objects containing information about discovered files.
The returned file objects will each contain name, path, type, size, and time fields.
Type: string
The remote path to be listed.
Returns the ssh2-sftp-client Client as a convenience.
Returns a Promise that resolves to undefined once a file has been transferred from S3 to the SFTP server.
Type: object
Type: string
The bucket containing the S3 object to be transferred to the SFTP server.
Type: string
The key of the S3 object to be transferred to the SFTP server.
Type: string
The full remote destination file path.
Returns a Promise that resolves to a string containing the S3 URI of the destination file
Type: string
The full path to the remote file to be fetched
Type: string
Destination S3 bucket of the file
Type: string
Destination S3 key of the file
Returns a Promise that resolves to undefined once the remote file has been deleted.
Type: string
The path to file on the SFTP server to be deleted
[v19.1.0] 2024-10-07
This release contains changes listed here as well as changes listed in v19.0.0, despite v19.0.0 being deprecated. Please review Changelog entries and Migration Notes for each Cumulus version between your current version and v19.1.0 as normal.
CUMULUS-3020
var.lambda_timeouts on the main cumulus module/archive modulePlease note - updating this configuration is for adavanced users only. Value changes will modify the visibility
timeout on sfEventSqsToDbRecordsDeadLetterQueue and sfEventSqsToDbRecordsInputQueue and may lead to system
instability.
CUMULUS-3756
CUMULUS-3773
@cumulus/sftp-client and @cumulus/ingest/SftpProviderClient to support both regular and fastDownload.FAQs
A Promise-based SFTP client
The npm package @cumulus/sftp-client receives a total of 91 weekly downloads. As such, @cumulus/sftp-client popularity was classified as not popular.
We found that @cumulus/sftp-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."