leadsender_s3/README.md

Простой клиент для работы с S3-хранилищем. Позволяет загружать, скачивать и просматривать файлы в папках.

<div align="center">
<br/>
<p>
    <a href="https://leadsender.net">
        <img src="https://leadsender.ru/img/logo.svg" title="LeadSender" alt="LeadSender" width="500" />
    </a>
</p>
<br/>
<p>
    <a href="https://www.npmjs.com/package/leadsender_s3">
        <img src="https://img.shields.io/npm/v/leadsender_s3.svg" alt="npm" />
    </a>
</p>
<br/>
</div>

# Клиент для S3 Beget

Простой клиент для работы с S3-хранилищем. Позволяет загружать, скачивать и просматривать файлы в папках.

## Установка

Для установки пакета выполните команду:

```bash
npm install leadsender_s3
```

## Инициализация клиента

Для начала работы создайте экземпляр клиента, передав параметры подключения:
```js
const Client = require('leadsender_s3');

const client = Client.create({
    endpoint: 'endpoint',
    region: 'region',
    bucket: 'bucket',
    accessKeyId: 'accessKeyId',
    secretAccessKey: 'secretAccessKey',
})

//Пример локального файла
const filePath = './storage/widget.zip';

//Пример загрузки локального файла в хранилище
client.uploadFile(filePath, `folderName/`);

//Пример скачивания файла из хранилища
client.downloadFile(`folderName/fileName.zip`, './downloads');

//Пример получения списка файлов
client.listFilesInFolder(`/`);
```