@maai-types/ali-oss

阿里云OSS模块的TypeScript类型定义

安装

npm install @maai-types/ali-oss

使用示例

import ossUtils from '@maai/ali-oss';

// 获取文件访问授权
const auth = await ossUtils.buildFileAuth('/path/to/file', 3600);

// 获取文件访问URL
const url = await ossUtils.buildFileUrl('/path/to/file', 3600);

// 获取文件内容
const file = await ossUtils.getFile('/path/to/file', true);

// 创建符号链接
const symlink = await ossUtils.putSymlink('/source/path', '/target/path');

API文档

OssUtils

buildFileAuth(path: string, timeout: number): Promise

生成文件访问授权

参数：

• path: 文件路径
• timeout: 授权有效期(秒)

返回：

interface OssFileAuth {
  accessKeyId: string;
  accessKeySecret: string;
  stsToken: string;
  expiration: string;
  requestId: string;
  region: string;
  bucket: string;
  basePath: string;
}

buildFileUrl(path: string, timeout: number): Promise

生成文件访问URL

参数：

• path: 文件路径
• timeout: URL有效期(秒)

getFile(path: string, force: boolean): Promise

获取文件内容

参数：

• path: 文件路径
• force: 是否强制刷新缓存

返回：

interface OssFile {
  name: string;
  code: number;
  msg: string;
  key: string;
  metadata: Map<String, String>;
  content: Uint8Array;
}

putSymlink(sourcePath: string, targetPath: string): Promise

创建符号链接

参数：

• sourcePath: 源文件路径
• targetPath: 目标路径

注意事项

1. 使用时需确保已正确配置阿里云OSS相关权限
2. 文件路径需以'/'开头
3. 权限配置文件位于项目目录的.env/oss.json，示例配置如下：

{
  "appKey": "xxxx",
  "appSecret": "xxxx",
  "bucket": "xxxx",
  "region": "cn-zhangjiakou",
  "clientId": "xxxx",
  "clientSecret": "xxxx",
  "roleArn": "xxxx",
  "basePath": "xxxx"
}

3. 授权和URL的有效期建议设置为合理值