Инструкция по эксплуатации

Переменные окружения

• S3_REGION - регион s3-хранилища для подключения
• S3_ENDPOINT - url подключаемого s3-хранилища
• S3_PUBLIC_ACCESS - Публичный ключ доступа к s3-хранилищу
• S3_PRIVATE_ACCESS - Приватный ключ доступа к s3-хранилищу
• S3_BUCKET_NAME - Имя бакета для подключения

Установка

yarn add nestjs-s3-manager

// или

npm i nestjs-s3-manager

Интеграция с nestjs-модуляим

Для использования данной библиотеки в своем проекте, необходимо:

1. Импортировать глобальный модуль S3ManagerModule в ваш корневой app.module.ts

@Module({
  imports: [
    ..., S3ManagerModule, ...
  ],
  controllers: [...],
  providers: [...],

})

2. Сделать инъекцию S3ManagerService в конструкторе вашего сервиса

constructor(private readonly S3Manager: S3ManagerService) {}

Готово! Сервис может использоваться

Выполнение операций

Загрузка одиночного файла

...
const key = await this.S3Manager.uploadOne(file, 'path/to/your/folder')
...

Получение уже загруженного файла

...
const file = await this.S3Manager.getOneOrThrow('your/key')
...

Можно также удалить файл

...
await this.S3Manager.deleteOneOrThrow('your/key')
...

Также поддерживается удаление сразу множества файлов