{"id":13487687,"url":"https://github.com/zzzs/egg-downloader","last_synced_at":"2025-03-27T23:31:20.069Z","repository":{"id":93871405,"uuid":"148017295","full_name":"zzzs/egg-downloader","owner":"zzzs","description":"extend a method context.downloader to download file for egg","archived":false,"fork":false,"pushed_at":"2018-09-16T04:10:06.000Z","size":91,"stargazers_count":9,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-30T23:35:29.554Z","etag":null,"topics":["downloader","egg","egg-plugin","javascript","node"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zzzs.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}},"created_at":"2018-09-09T11:05:29.000Z","updated_at":"2023-05-09T05:11:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"6aed3757-bdbf-446d-b307-724784464afb","html_url":"https://github.com/zzzs/egg-downloader","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzzs%2Fegg-downloader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzzs%2Fegg-downloader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzzs%2Fegg-downloader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzzs%2Fegg-downloader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zzzs","download_url":"https://codeload.github.com/zzzs/egg-downloader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245944068,"owners_count":20697943,"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":["downloader","egg","egg-plugin","javascript","node"],"created_at":"2024-07-31T18:01:02.107Z","updated_at":"2025-03-27T23:31:19.797Z","avatar_url":"https://github.com/zzzs.png","language":"JavaScript","funding_links":[],"categories":["Plugins","仓库"],"sub_categories":["插件"],"readme":"# egg-downloader\n\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![Test coverage][codecov-image]][codecov-url]\n[![David deps][david-image]][david-url]\n[![Known Vulnerabilities][snyk-image]][snyk-url]\n[![npm download][download-image]][download-url]\n\n\n[npm-image]: https://img.shields.io/npm/v/egg-downloader.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/egg-downloader\n[travis-image]: https://img.shields.io/travis/zzzs/egg-downloader.svg?style=flat-square\n[travis-url]: https://travis-ci.org/zzzs/egg-downloader\n[codecov-image]: https://img.shields.io/codecov/c/github/zzzs/egg-downloader.svg?style=flat-square\n[codecov-url]: https://codecov.io/github/zzzs/egg-downloader?branch=master\n[david-image]: https://img.shields.io/david/zzzs/egg-downloader.svg?style=flat-square\n[david-url]: https://david-dm.org/zzzs/egg-downloader\n[snyk-image]: https://snyk.io/test/github/zzzs/egg-downloader/badge.svg?targetFile=package.json\n[snyk-url]: https://snyk.io/test/github/zzzs/egg-downloader?targetFile=package.json\n[download-image]: https://img.shields.io/npm/dm/egg-downloader.svg?style=flat-square\n[download-url]: https://npmjs.org/package/egg-downloader\n\nextend a method `ctx.downloader` to download file\n\n## Install\n\n```bash\n$ npm i egg-downloader --save\n```\n\n## Usage\n\n```js\n// {app_root}/config/plugin.js\nexports.downloader = {\n  enable: true,\n  package: 'egg-downloader',\n};\n```\n\n## Features\n`ctx.downloader`用于提供文件下载的功能，支持三个参数，ctx.download(file, [name], [header]) \n  \n  * file: 必选，文件路径\n  * name: 可选，下载文件名（包含后缀）\n  * header: 可选，附加头信息, 并且header会改为全部小写（感谢[天猪](https://github.com/atian25)的建议：egg 推荐 header 全部小写，会有一定的性能提升）。\n\n\u003e 如果 file 是个不带路径的文件，将默认视为下载 app/public/file 。\n\n## Example\n```js\n// {app_root}/controller/home.js\nconst Controller = require('egg').Controller;\nclass HomeController extends Controller {\n  async index() {\n    // 下载为 package.json\n    this.ctx.downloader('./package.json');\n    \n    // 下载为 new-name.json\n    // this.ctx.downloader('package.json', 'new-name.json');\n    \n    // 下载为 new-name.json, header: X-Token: 123\n    // this.ctx.downloader('package.json', 'new-name.json', { 'x-token': '123' });\n  }\n}\nmodule.exports = HomeController;\n```\n\n## Questions \u0026 Suggestions\n\nPlease open an issue [here](https://github.com/zzzs/egg-downloader/issues).\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzzs%2Fegg-downloader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzzzs%2Fegg-downloader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzzs%2Fegg-downloader/lists"}