@ducktors/ streagebus-s3 (英语)

AWS S3 存储适配器 存储总线。 。 。 .

安装

npm install @ducktors/storagebus-s3
# or
pnpm add @ducktors/storagebus-s3
# or
yarn add @ducktors/storagebus-s3

使用量

import { Storage } from '@ducktors/storagebus-s3'
import { Readable } from 'node:stream'

// Using explicit credentials
const storage = new Storage({
  bucket: 'your-s3-bucket',
  region: 'us-east-1',
  accessKeyId: 'your-access-key-id',
  secretAccessKey: 'your-secret-access-key',
})

// Or using default credentials (IAM role, environment variables, etc.)
const storageWithDefaultCreds = new Storage({
  bucket: 'your-s3-bucket',
  region: 'us-east-1',
})

async function main() {
  const readable = Readable.from('Hello, world!')

  // Write a file
  const writtenFile = await storage.write('path/to/file.txt', readable)

  // Write with progress tracking
  await storage.write('path/to/large-file.txt', readable, {
    progress: (p) => console.log(`Uploaded: ${p.loaded} bytes`),
  })

  // Write with server-side encryption
  await storage.write('path/to/encrypted.txt', readable, {
    entryption: {
      ServerSideEncryption: 'aws:kms',
      SSEKMSKeyId: 'your-kms-key-id',
    },
  })

  // Check if file exists
  const exists = await storage.exists('path/to/file.txt')

  // Read a file
  const fileStream = await storage.read('path/to/file.txt')

  // Copy a file
  const copiedFile = await storage.copy('path/to/file.txt', 'path/to/copy.txt')

  // Copy to a different bucket
  await storage.copy('path/to/file.txt', 'path/to/copy.txt', {
    destBucket: 'another-bucket',
  })

  // Move a file
  const movedFile = await storage.move('path/to/copy.txt', 'new/path/file.txt')

  // Delete a file
  await storage.remove('path/to/file.txt')
}

API 密码

构造选项

方法

写入 Opts

复制对象

移动 Opts

认证

这个适配器支持多种认证方法:

1. 全权证书: 传出 accessKeyId 财务报告和审定财务报表 secretAccessKey 到构造器
2. 环境变量设置 AWS_ACCESS_KEY_ID 财务报告和审定财务报表 AWS_SECRET_ACCESS_KEY
3. IAM 角色:在AWS基础设施上运行时(EC2,Lambda,ECS等)
4. AWS 证书文件数字 : ~/.aws/credentials

见 AWS SDK 证书文件 更多细节.

许可证

麻省理工学院