> For the complete documentation index, see [llms.txt](https://brianbuccaneer.gitbook.io/bottlenose/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brianbuccaneer.gitbook.io/bottlenose/vbeta/sources-and-sinks/rxs3.md).

# rxs3 (AWS S3)

[![CircleCI](https://circleci.com/gh/buccaneerai/bottlenose/tree/master.svg?style=shield)](https://circleci.com/gh/buccaneerai/bottlenose/tree/master) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)  [![](https://img.shields.io/npm/v/@bottlenose/rxs3.svg)](https://www.npmjs.com/package/@bottlenose/rxs3)

### Description

`@bottlenose/rxs3` is part of the [Bottlenose](https://github.com/buccaneerai/bottlenose) project. It allows for the upload and download of s3 files as streams (instead of a single larger HTTP payload). Why?

* This is very important when working with big files. (Even a 1MB file can take significant time to upload.)
* With some filetypes (like CSV, certain JSON formats and audio) this enables processing data immediately even if the full file takes longer to download.
* It is also useful with data streams (audio, big csv files, video, human DNA, etc).
* This approach can conserve memory since only a small chunk of the file needs to be held in memory at any given time.
* This approach can handle connectivity failures. Imagine downloading a big 50GB file and losing connection after downloading 49GB of it.  No fun!

### Installation

#### npm

```bash
npm i @bottlenose/rxs3 --save
```

#### yarn

```bash
yarn add @bottlenose/rxs3
```

#### Compatability

| Platform        | Support |
| --------------- | ------- |
| node.js (>10.0) | ✅       |
| Browsers        | ✅       |
| React Native    | ✅       |
| Electron        | ✅       |

## Documentation & Guides

* [Documentation & Guides](https://buccaneerai.gitbook.io/bottlenose/sources-and-sinks/rxs3)