fix sftp-client usage docs #3936
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When you run the example usage code from `sftp-client` as is, it throws the following error because we're sending a command before connecting to the sftp server: ``` /home/aku/code/random/sftp-client/node_modules/.pnpm/@Cumulus[email protected][email protected]/node_modules/@cumulus/sftp-client/dist/index.js:78 throw new Error('Client not connected'); ^ Error: Client not connected at get sftp (/home/aku/code/random/sftp-client/node_modules/.pnpm/@Cumulus[email protected][email protected]/node_modules/@cumulus/sftp-client/dist/index.js:78:19) at SftpClient.list (/home/aku/code/random/sftp-client/node_modules/.pnpm/@Cumulus[email protected][email protected]/node_modules/@cumulus/sftp-client/dist/index.js:180:40) at file:///home/aku/code/random/sftp-client/index.ts:18:32 at file:///home/aku/code/random/sftp-client/index.ts:52:3 at ModuleJob.run (node:internal/modules/esm/module_job:268:25) at async onImport.tracePromise.__proto__ (node:internal/modules/esm/loader:543:26) at async asyncRunEntryPointWithESMLoader (node:internal/modules/run_main:116:5) ```
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When you run the example usage code from
sftp-clientas is, it throws the following error because we're sending a command before connecting to the sftp server:Summary: Summary of changes
Addresses CUMULUS-XX: Develop amazing new feature
Changes
PR Checklist