# @adobe/aio-lib-files 中文文档 规范地址：https://npmcn.com/package/%40adobe/aio-lib-files/ 版本：4\.1\.4 npm 元数据更新时间：2026-10-01T01:32:27.976Z 中文译文更新时间：2026-11-05T20:17:55.449Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40adobe/aio-lib-files 原文对照：https://npmcn.com/package/%40adobe/aio-lib-files/?lang=original 项目主页：https://github.com/adobe/aio-lib-files#readme 源码仓库：https://github.com/adobe/aio-lib-files ## 关键信息（来自 npm 元数据） - 包体积（解压后）：259 kB，36 个文件 - 模块格式：CommonJS - TypeScript 类型：包内自带 - Node.js 要求：\>=20 - 运行依赖：14 个 - 首次发布：2019-09-09T16:38:37.728Z - 最新版本发布：2026-05-29T14:32:16.400Z - 近 30 天下载量：29778（2026-10-05 至 2026-11-03，npm 官方下载统计） - 已发布版本数：37（近 12 个月 2 个） ## 中文简介 Blob 云存储上方的抽象显示, 显示文件如 API ## 安装 ```sh npm install @adobe/aio-lib-files ``` 也可以使用：`pnpm add @adobe/aio-lib-files`、`yarn add @adobe/aio-lib-files`、`bun add @adobe/aio-lib-files` ## README [![Version](https://img.shields.io/npm/v/@adobe/aio-lib-files.svg)](https://npmjs.org/package/@adobe/aio-lib-files) [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-lib-files.svg)](https://npmjs.org/package/@adobe/aio-lib-files) ![Node.js CI](https://github.com/adobe/aio-lib-files/workflows/Node.js%20CI/badge.svg) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-lib-files/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-lib-files/) # Adobe I/O Lib 文件 云blob存储上方的节点JavaScript抽象化会暴露出像API这样的文件系统. 您可以用您的 Adobe I/ O 运行时间( a. k. a OpenWhisk) 初始化 SDK 证书. 或者,你可以带自己的云存储键。 但请注意,作为: 现在我们只支持Azure Blob存储器. 请注意,你目前必须是 [Adobe 开发者 App 构建器](https://www.adobe.io/apis/experienceplatform/project-firefly.html) 要使用此图书馆。 App Builder是一个完整的框架,使企业开发者能够构建并部署自定义的网络应用程序来扩展Adobe体验云解决方案并运行在Adobe基础设施上. ## 安装 ```bash npm install @adobe/aio-lib-files ``` ## 使用 ```js const filesLib = require('@adobe/aio-lib-files') // init // init sdk using OpenWhisk credentials const files = await filesLib.init({ ow: { namespace, auth } }) // init when env vars __OW_API_KEY and __OW_NAMESPACE are set (e.g. when running in an OpenWhisk action) const files = await filesLib.init() // or if you want to use your own cloud storage account const files = await filesLib.init({ azure: { storageAccount, storageAccessKey, containerName } }) // write private file await files.write('mydir/myfile.txt', 'some private content') // write publicly accessible file await files.write('public/index.html', '

Hello World!

') // get file url const props = await files.getProperties('public/index.html') console.log('props = ', props) /* props = { name: 'public/index.html', creationTime: 2020-12-09T19:49:58.000Z, lastModified: 2020-12-09T19:49:58.000Z, etag: '"0x8D89C7B9BB75A6F"', contentLength: 21, contentType: 'text/html', isDirectory: false, isPublic: true, url: 'https://jestaiotest.blob.core.windows.net/readme-public/public%2Findex.html' } */ // list all files await files.list('mydir/') // with a trailing slash lists a directory, recursively. Returns [] if no files are recursively stored under mydir/. await files.list('myfile') // without a trailing slash list returns [fileProps] or [] if it doesn't exist. await files.list('/') /* list = [ { name: 'mydir/myfile.txt', creationTime: 2020-12-09T19:49:57.000Z, lastModified: 2020-12-09T19:49:57.000Z, etag: '0x8D89C7B9BB165F8', contentLength: 20, contentType: 'text/plain', isDirectory: false, isPublic: false, url: 'https://jestaiotest.blob.core.windows.net/readme/mydir%2Fmyfile.txt' }, { name: 'public/index.html', creationTime: 2020-12-09T19:49:58.000Z, lastModified: 2020-12-09T19:49:58.000Z, etag: '0x8D89C7B9BB75A6F', contentLength: 21, contentType: 'text/html', isDirectory: false, isPublic: true, url: 'https://jestaiotest.blob.core.windows.net/readme-public/public%2Findex.html' } ] */ // read const buffer = await files.read('mydir/myfile.txt') buffer.toString() // 'some private content' // pipe read stream to local file (consider using copy below) const rdStream = await files.createReadStream('mydir/myfile.txt') const stream = rdStream.pipe(fs.createWriteStream('my-local-file.txt')) stream.on('finish', () => console.log('done!')) // write read stream to remote file (consider using copy below) const rdStream = fs.createReadStream('my-local-file.txt') await files.write('my/remote/file.txt', rdStream) // delete files in 'my/remote/' dir await files.delete('my/remote/') // delete all public files await files.delete('public/') // delete all files including public await files.delete('/') // copy - higher level utility (works likes scp) // works for files and directories both remotely and locally, uses streams under the hood /// upload a single file await files.copy('my-static-app/index.html', 'public/my-static-app/index.html', { localSrc: true }) /// upload local directory recursively await files.copy('my-static-app/', 'public/', { localSrc: true }) /// download to local directory recursively (works for files as well) await files.copy('public/my-static-app/', 'my-static-app-copy', { localDest: true }) /// copy remote directories around (works for files as well) await files.copy('public/my-static-app/', 'my/private/folder') // Share private files const presignUrl = await files.generatePresignURL('mydir/myfile.txt', { expiryInSeconds: 60 }) //Share private files with read, write, delete permissions const rwdPresignUrl = await files.generatePresignURL('mydir/myfile.txt', { expiryInSeconds: 60, permissions: 'rwd' }) ``` ## 指定 URL 类型和使用 文件 SDK 支持两种预签名的 URL 访问文件 1. 外部 - 基于 CDN 的 URL , 可以从任何地方访问, 假设私人文件的右前缀权限 。 您可以使用此类型的 URL 为远程计算使用大小写提供对外部系统和 API 文件的访问 . 2. 内部 - 文件存储的直接URL. 这些 URL 只有在 Adobe I/ O 运行时动作中使用时才有效 。 您可以使用这种类型的 URL 来链接正在从不同的运行时命名空间处理相同文件的工人动作 。 由于没有 CDN 间接, 使用这种类型的 URL 将改善您运行时动作的性能 . [文件. get 财产](https://npmcn.com/package/%40adobe/aio-lib-files/doc/api.md#Files+getProperties) 返回给定文件路径的 URL 类型( 外部为 url, 内部为 内部 Url) [文件. generate PresignURL](https://npmcn.com/package/%40adobe/aio-lib-files/doc/api.md#Files+generatePresignURL) 支持 UrlType 作为生成指定类型的预签名 URL 的选项 参见下面的用法示例 - ```js const { init, UrlType } = require('@adobe/aio-lib-files') const files = await init() // getProperties will return both internal and external URLs in return Object const props = files.getProperties('public/my-static-app/index.html') //generate presign URL with internal URLType const internalPresignUrl = await files.generatePresignURL('mydir/myfile.txt', { expiryInSeconds: 60, permissions: 'rwd', urltype: UrlType.internal }) ``` ## 探索 `goto` [API 密码](https://npmcn.com/package/%40adobe/aio-lib-files/doc/api.md) ## 调试 设定 `DEBUG=@adobe/aio-lib-files*` 以查看调试日志. ## Adobe I/O 文件存储一致性保证 **强有力的一致性** 保证所有操作以及文件sdk(由 `filesLib.init()`) (中文(简体) ). ## 解决问题 ### `"[StateLib:ERROR_INTERNAL] unknown error response from provider with status: unknown"` - 使用时 `@adobe/aio-lib-files` 与 **网络软件包** 请确保关闭 minific化 并能够解析 Es6 模块 。 在您的网络包配置中添加以下行 : ```javascript optimization: { minimize: false }, resolve: { extensions: ['.js'], mainFields: ['main'] } ``` ## 捐款 欢迎捐款! 读取 [贡献指南](https://npmcn.com/package/%40adobe/aio-lib-files/.github/CONTRIBUTING.md) 更多信息. ## 许可证发放 这个项目根据Apache V2许可证获得许可. 见 [自由主义](https://npmcn.com/package/%40adobe/aio-lib-files/LICENSE) 更多信息. ## 常见问题 ### @adobe/aio-lib-files 是什么？ Blob 云存储上方的抽象显示, 显示文件如 API ### 如何安装 @adobe/aio-lib-files？ 在项目目录运行 npm install @adobe/aio-lib-files，或使用 pnpm add / yarn add / bun add。 ### @adobe/aio-lib-files 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @adobe/aio-lib-files 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @adobe/aio-lib-files 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @adobe/aio-lib-files 可以商用吗？ @adobe/aio-lib-files 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @adobe/aio-lib-files 的下载量有多少？ 根据 npm 官方下载统计，@adobe/aio-lib-files 在 2026/10/05 – 2026/11/03 这 30 天内被下载 29,778 次，日均约 993 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @adobe/aio-lib-files 还在维护吗？ 最新版本 4\.1\.4 发布于 2026/05/29（5 个月前）；至今共发布 37 个版本，其中过去 12 个月发布了 2 个；首次发布于 2019/09/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。