{"id":21997721,"url":"https://github.com/osfunapps/os-s3-handler-npm","last_synced_at":"2026-04-08T18:02:32.212Z","repository":{"id":98762450,"uuid":"207132376","full_name":"osfunapps/os-s3-handler-npm","owner":"osfunapps","description":"This module meant to provide intuitive functions to work with AWS's S3.","archived":false,"fork":false,"pushed_at":"2021-02-07T15:06:44.000Z","size":7,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-21T12:41:37.134Z","etag":null,"topics":["amazon","aws","download","nodejs","npm","osfunapps","s3","tools","upload","utils"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osfunapps.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-09-08T15:25:39.000Z","updated_at":"2021-02-07T15:06:46.000Z","dependencies_parsed_at":"2023-05-25T05:30:42.697Z","dependency_job_id":null,"html_url":"https://github.com/osfunapps/os-s3-handler-npm","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osfunapps/os-s3-handler-npm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osfunapps%2Fos-s3-handler-npm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osfunapps%2Fos-s3-handler-npm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osfunapps%2Fos-s3-handler-npm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osfunapps%2Fos-s3-handler-npm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osfunapps","download_url":"https://codeload.github.com/osfunapps/os-s3-handler-npm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osfunapps%2Fos-s3-handler-npm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31567227,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["amazon","aws","download","nodejs","npm","osfunapps","s3","tools","upload","utils"],"created_at":"2024-11-29T22:17:51.145Z","updated_at":"2026-04-08T18:02:32.194Z","avatar_url":"https://github.com/osfunapps.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Introduction\n------------\n\nThis module meant to provide intuitive functions to work with AWS's S3.\n\n## Installation\n\nNOTICE:  \nin order to make it work, you would need to install [aws-cli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\nand run *aws configure* to configure your profile.\n\nInstall via npm:\n```js    \nnpm i os-s3-handler\n```\n\n## Usage       \nRequire fsh:\n```js\nvar s3h = require(\"os-s3-handler\")\n```\n## Functions and signatures:\n```js    \n /**\n * Will download all of the files with to the same extension from an S3 path.\n *\n * @param s3LocalPath -\u003e the local path of the files in the bucket (/remotes/Samsung)\n * @param destPath -\u003e the path to which the files will be downloaded\n * @param extension -\u003e the extension you wish to look for\n * @param lookInSubDirsAlso -\u003e set to true if you want to download from sub dirs as well\n * @param timeout -\u003e how long to wait for the download to complete. NOTICE: IT'S IMPERATIVE\n * TO SET THIS ARG AS THE SHITTY S3 CLI DOESN'T INFORM WHEN IT IS DONE DOWNLOADING FILES.\n */\nasync downloadAllByExtension(s3LocalPath, destPath, extension, lookInSubDirsAlso, timeout)\n\n/**\n * Will download a file from an S3 path.\n *\n * @param s3LocalPath -\u003e the local path of the files in the bucket (/remotes/Samsung)\n * @param destPath -\u003e the path to which the files will be downloaded\n * @param fileName -\u003e the file name incl the extension you wish to look for\n * @param timeout -\u003e how long to wait for the download to complete. NOTICE: IT'S IMPERATIVE\n * TO SET THIS ARG AS THE SHITTY S3 CLI DOESN'T INFORM WHEN IT IS DONE DOWNLOADING FILES.\n */\nasync downloadFile(s3LocalPath, destPath, fileName, timeout) \n\n/**\n * Will run an ls command in a given path destination\n *\n * @param bucketName -\u003e the name of your bucket\n * @param s3LocalPath -\u003e the local path to the destination (for root leave as is)\n * @param listFiles -\u003e set to true if you want to get the files\n * @param listDirs -\u003e set to true if you want to get the dirs\n * @return array -\u003e of\n */\nasync listFilesAndDirs(bucketName, s3LocalPath = \"\", listFiles=true, listDirs=true)\n```  \nAnd more...\n\n\n## Links -\u003e see more tools\n* [os-tools-npm](https://github.com/osfunapps/os-tools-npm) -\u003e This module contains fundamental functions to implement in an npm project\n* [os-file-handler-npm](https://github.com/osfunapps/os-file-handler-npm) -\u003e This module contains fundamental files manipulation functions to implement in an npm project\n* [os-file-stream-handler-npm](https://github.com/osfunapps/os-file-stream-handler-npm) -\u003e This module contains read/write and more advanced operations on files\n* [os-xml-handler-npm](https://github.com/osfunapps/os-xml-handler-npm) -\u003e This module will build, read and manipulate an xml file. Other handy stuff is also available, like search for specific nodes\n\n[GitHub - osfunappsapps](https://github.com/osfunapps)\n\n## Licence\nISC","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosfunapps%2Fos-s3-handler-npm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosfunapps%2Fos-s3-handler-npm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosfunapps%2Fos-s3-handler-npm/lists"}