{"id":50361650,"url":"https://github.com/roberto-naharro/rx-node-ftp-client","last_synced_at":"2026-05-30T02:03:23.985Z","repository":{"id":32697311,"uuid":"138737474","full_name":"roberto-naharro/rx-node-ftp-client","owner":"roberto-naharro","description":"A Reactive and Typescript version of the module ftp-client","archived":false,"fork":false,"pushed_at":"2022-12-30T20:18:12.000Z","size":811,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-10T23:15:49.671Z","etag":null,"topics":["client","ftp","observable","reactive","rx","rxjs","transfer"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roberto-naharro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-26T12:50:26.000Z","updated_at":"2020-11-23T10:56:48.000Z","dependencies_parsed_at":"2023-01-14T21:57:42.274Z","dependency_job_id":null,"html_url":"https://github.com/roberto-naharro/rx-node-ftp-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/roberto-naharro/rx-node-ftp-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roberto-naharro%2Frx-node-ftp-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roberto-naharro%2Frx-node-ftp-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roberto-naharro%2Frx-node-ftp-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roberto-naharro%2Frx-node-ftp-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roberto-naharro","download_url":"https://codeload.github.com/roberto-naharro/rx-node-ftp-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roberto-naharro%2Frx-node-ftp-client/sbom","scorecard":{"id":780342,"data":{"date":"2025-08-11","repo":{"name":"github.com/roberto-naharro/rx-node-ftp-client","commit":"52c26e1ef34d2d0371634db805a082b69ffa52e7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/17 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"30 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-897m-rjf5-jp39","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T04:45:18.342Z","repository_id":32697311,"created_at":"2025-08-23T04:45:18.342Z","updated_at":"2025-08-23T04:45:18.342Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33677261,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","ftp","observable","reactive","rx","rxjs","transfer"],"created_at":"2026-05-30T02:03:23.141Z","updated_at":"2026-05-30T02:03:23.977Z","avatar_url":"https://github.com/roberto-naharro.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rx-node-ftp-client\n\n## Description\n\nrx-node-ftp-client is an observable version of the package  [ftp-client](https://github.com/noodny/node-ftp-client) - with some improvements.\n\n## Requirements\n\n* [node.js](http://nodejs.org/) -- v0.8.0 or newer\n* npm -- v2.0.0 or newer\n\n## Dependencies\n\n* [rxjs](https://github.com/reactivex/rxjs) -- v6.2.1\n* [ftp](https://github.com/mscdex/node-ftp) -- v0.3.10\n* [glob](https://github.com/isaacs/node-glob) -- v7.1.2\n* [lodash](https://github.com/lodash/lodash-node) -- v4.17.10\n* [path](https://github.com/jinder/path) -- v4.17.10\n* [upath](https://github.com/anodynos/upath) -- v1.1.10\n\n## Installation\n\n    npm install rx-node-ftp-client\n\n## Usage\n\n### Initialization\n\nTo create an instance of the FTP client object:\n\nTypeScript:\n\n```typescript\nimport { Client } from 'rx-node-ftp-client';\nftpClient = new Client(config, options);\n```\n\nwhere `config` contains the ftp server configuration (these are the default values):\n\n```javascript\n{\n    host: 'localhost',\n    port: 21,\n    user: 'anonymous',\n    password: 'anonymous@'\n}\n```\n\n(To check more options, see [the ftp npm package](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/ftp/index.d.ts#L18))\n\nand the `options` object may contain the following keys:\n\n* *logging* (String): `'none'`, `'basic'`, `'debug'` - level of logging for all the tasks - use `'debug'` in case of any issues\n* *Logger* (Console): default `console` - if you want to inject your custom logger, use this property\n* *overwrite* (String): `'none'`, `'older'`, `'all'` - determines which files should be overwritten when downloading/uploading - `'older'` compares the date of modification of local and remote files\n* *testingTimezoneDir* (String): default `null` - using default home directory if `null`. The directory should have Read/Write permission in order to adjust timezone for overwriting files.\n* *globOptions* (Glob configuraion object): default `{ nonull: false }` - Custom glob options for file search.\n* *disconnect* (boolean): default `true` - disconnect from ftp after an upload or download operation.\n\n#### Connecting\n\nAfter creating the new object you have to manually connect to the server by using the `connect` method:\n\n```typescript\nftpClient.connect().subscribe(\n  () =\u003e console.log('Connected'),\n  err =\u003e console.error(err),\n  () =\u003e {\n    console.log('Operation finished'),\n  },\n);\n```\n\n#### Disconnected\n\nIf you choose the option of manually disconnect from the server, you have to use the `disconnect` method:\n\n```typescript\nftpClient.disconnect().subscribe(\n  () =\u003e console.log('Disconnected'),\n  err =\u003e console.error(err),\n  () =\u003e {\n    console.log('Operation finished'),\n  },\n);\n```\n\n### Methods\n\n* **download**(source: string, dest: string, options?: Options):\n  Observable\u003c DownloadResults \u003e - downloads the contents\nof `source` to `dest` if both exist. The next function returns the following object:\n\n```typescript\n{\n  downloadedFiles: string[],\n  errors: {\n    [origin: string]: Error,\n  },\n}\n```\n\n* **upload**(patterns: string | string[], dest: string,\n  options?: Options): Observable\u003c UploadResults \u003e - expands the source paths\nusing the glob module (`patterns` argument), uploads all found files and directories to the specified `dest`. The next function returns the following object:\n\n```typescript\n{\n  uploadedFiles: string[],\n  uploadedDirs: string[],\n  errors: {\n    [origin: string]: Error,\n  },\n}\n```\n\n## Examples\n\nIn this example we connect to a server, and simultaneously upload all files from the `test` directory, overwriting only\nolder files found on the server, and download files from `/public_html/test` directory.\n\n```typescript\nimport { Client, Options, Config } from './lib/client';\nimport * as upath from 'upath';\nimport { switchMapTo } from 'rxjs/operators';\n\nconst config: Config = {\n  host: 'localhost',\n  port: 21,\n  user: 'anonymous',\n  password: 'anonymous@',\n};\nconst options: Options = {\n  logging: 'basic',\n};\n\nconst ftpClient = new Client(config, options);\n\nftpClient.connect().pipe(\n  switchMapTo(ftpClient.upload(\n    upath.join(__dirname, 'test/*'),\n    './',\n    { baseDir: __dirname },\n  )),\n).subscribe(\n  results =\u003e console.info(results),\n  err =\u003e console.error(err),\n  () =\u003e console.info('Upload Complete'),\n);\n\nftpClient.connect().pipe(\n  switchMapTo(ftpClient.download(\n    '/public_html/test',\n    __dirname,\n  )),\n).subscribe(\n  results =\u003e console.info(results),\n  err =\u003e console.error(err),\n  () =\u003e console.info('Download Complete'),\n);\n```\n\n## TODO\n\n* Update this document with the different functions added\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froberto-naharro%2Frx-node-ftp-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froberto-naharro%2Frx-node-ftp-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froberto-naharro%2Frx-node-ftp-client/lists"}