{"id":16698003,"url":"https://github.com/arlac77/sftp-resolver-fs","last_synced_at":"2025-04-10T02:53:39.439Z","repository":{"id":22403139,"uuid":"96150214","full_name":"arlac77/sftp-resolver-fs","owner":"arlac77","description":"resolves sftp urls","archived":false,"fork":false,"pushed_at":"2025-03-17T14:43:55.000Z","size":1619,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T15:51:47.739Z","etag":null,"topics":["sftp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"0bsd","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arlac77.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-03T21:02:27.000Z","updated_at":"2025-02-16T21:01:24.000Z","dependencies_parsed_at":"2023-02-14T00:16:04.979Z","dependency_job_id":"59fe1990-9777-4c50-a1c8-36516bd57ee7","html_url":"https://github.com/arlac77/sftp-resolver-fs","commit_stats":{"total_commits":922,"total_committers":7,"mean_commits":"131.71428571428572","dds":"0.12798264642082424","last_synced_commit":"7d5ff6b63ea7034423a345fd17306054c4e0034b"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fsftp-resolver-fs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fsftp-resolver-fs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fsftp-resolver-fs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arlac77%2Fsftp-resolver-fs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arlac77","download_url":"https://codeload.github.com/arlac77/sftp-resolver-fs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248147315,"owners_count":21055523,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["sftp"],"created_at":"2024-10-12T17:50:15.935Z","updated_at":"2025-04-10T02:53:39.422Z","avatar_url":"https://github.com/arlac77.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm](https://img.shields.io/npm/v/sftp-resolver-fs.svg)](https://www.npmjs.com/package/sftp-resolver-fs)\n[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)\n[![bundlejs](https://deno.bundlejs.com/?q=sftp-resolver-fs\\\u0026badge=detailed)](https://bundlejs.com/?q=sftp-resolver-fs)\n[![downloads](http://img.shields.io/npm/dm/sftp-resolver-fs.svg?style=flat-square)](https://npmjs.org/package/sftp-resolver-fs)\n[![GitHub Issues](https://img.shields.io/github/issues/arlac77/sftp-resolver-fs.svg?style=flat-square)](https://github.com/arlac77/sftp-resolver-fs/issues)\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fsftp-resolver-fs%2Fbadge\\\u0026style=flat)](https://actions-badge.atrox.dev/arlac77/sftp-resolver-fs/goto)\n[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/sftp-resolver-fs/badge.svg)](https://snyk.io/test/github/arlac77/sftp-resolver-fs)\n[![Coverage Status](https://coveralls.io/repos/arlac77/sftp-resolver-fs/badge.svg)](https://coveralls.io/github/arlac77/sftp-resolver-fs)\n\n## sftp-resolver-fs\n\nresolves sftp urls\n\n# API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n### Table of Contents\n\n*   [SFTPScheme](#sftpscheme)\n    *   [Parameters](#parameters)\n    *   [get](#get)\n        *   [Parameters](#parameters-1)\n    *   [name](#name)\n    *   [defaultPort](#defaultport)\n    *   [isSecure](#issecure)\n    *   [optionsFromEnvironment](#optionsfromenvironment)\n        *   [Parameters](#parameters-2)\n\n## SFTPScheme\n\n**Extends URLScheme**\n\nURLScheme for sftp access\n\n### Parameters\n\n*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)\n\n    *   `options.privateKey` **([UInt8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [Buffer](https://nodejs.org/api/buffer.html))**\u0026#x20;\n\n### get\n\nCreates a readable stream for the content of th file associated to a given file URL\n\n#### Parameters\n\n*   `context` **Context**\u0026#x20;\n*   `url` **[URL](https://developer.mozilla.org/docs/Web/API/URL/URL)** of the a file\n*   `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** passed as options to fs.createReadStream()\n\nReturns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\\u003cReadableStream\u003e** of the file content\n\n### name\n\nScheme name is 'sftp'\n\nReturns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'sftp'\n\n### defaultPort\n\nReturns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 22 the sftp default port\n\n### isSecure\n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true\n\n### optionsFromEnvironment\n\nExtract options suitable for the constructor\nform the given set of environment variables\n\n#### Parameters\n\n*   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**\u0026#x20;\n\nReturns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** undefined if no suitable environment variables have been found\n\n# install\n\nWith [npm](http://npmjs.org) do:\n\n```shell\nnpm install sftp-resolver-fs\n```\n\n# license\n\nBSD-2-Clause\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farlac77%2Fsftp-resolver-fs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farlac77%2Fsftp-resolver-fs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farlac77%2Fsftp-resolver-fs/lists"}