<commit_before># Streaming-S3

[![Build Status](https://travis-ci.org/talha-asad/streaming-s3.png?branch=master)](https://travis-ci.org/talha-asad/streaming-s3)

A simple and light-weight S3 upload streaming module for NodeJS.


## Benefits & Features
* Tons of configurable options
* Low memory usage
* Parallel part uploading
* Simple interface (Asynchronous and evented)
* Downloading and uploading statistics (U/D speed and U/D time)
* Super fast
* Proper usage of streams and graceful error handling
* Production ready (Used and tested on production environments, uploading gigabytes of files to S3)
* Uses official AWS SDK


## Installation

```
$ npm install streaming-s3
```


## Example Usage


### Example 1: Uploading local file with callback.

```js
var Streaming-S3 = require('streaming-s3'),
    fs = require('fs');<commit_msg>fixed parameter configuration<commit_after># Streaming-S3

[![Build Status](https://travis-ci.org/talha-asad/streaming-s3.png?branch=master)](https://travis-ci.org/talha-asad/streaming-s3)
[![Dependency Status](https://www.versioneye.com/user/projects/5323a411ec13758e7d000109/badge.png)](https://www.versioneye.com/user/projects/5323a411ec13758e7d000109)

A simple and light-weight S3 upload streaming module for NodeJS.


## Benefits & Features
* Tons of configurable options
* Low memory usage
* Parallel part uploading
* Simple interface (Asynchronous and evented)
* Downloading and uploading statistics (U/D speed and U/D time)
* Super fast
* Proper usage of streams and graceful error handling
* Production ready (Used and tested on production environments, uploading gigabytes of files to S3)
* Uses official AWS SDK


## Installation

```
$ npm install streaming-s3
```


## Example Usage


### Example 1: Uploading local file with callback.

```js
var Streaming-S3 = require('streaming-s3'),
    fs = require('fs');
{'fraction_non_alphanumeric': 0.1131367292225201, 'fraction_numerical': 0.030026809651474532, 'mean_word_length': 4.923809523809524, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1581822', 'n_tokens_mistral': 625, 'n_tokens_neox': 569, 'n_words': 177}