Skip to content

Commit

Permalink
fixed parameter configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
talha-asad committed Mar 14, 2014
1 parent d8f5639 commit cafdc1f
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 2 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014 talha-asad
Copyright (c) 2014 Talha Asad

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
80 changes: 79 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,82 @@ uploader.on('error', function (e) {
```


### Example 3
### Example 2: Uploading remote file without callback and options

```js
var Streaming-S3 = require('streaming-s3'),
request = require('request');

var rStream = request.get('http://www.google.com');
var uploader = new Streaming-S3(rStream, 'accessKey', 'secretKey',
{
Bucket: 'example.streaming-s3.com',
Key: 'google.html',
ContentType: 'text/html'
},
{
concurrentParts: 2,
waitTime: 10000,
retries: 1,
maxPartSize: 10*1024*1024,
}
);

uploader.begin(); // important if callback not provided.

uploader.on('data', function (e, bytesRead) {
console.log(bytesRead, ' bytes read.');
});

uploader.on('partUploaded', function (e, partNumber) {
console.log(partNumber, ' part uploaded.');
});

// All parts uploaded, but upload not yet acknowledged.
uploader.on('uploaded', function (e, stats) {
console.log('Upload stats: ', stats);
});

uploader.on('finished', function (e, resp, stats) {
console.log('Upload finished: ', resp);
});

uploader.on('error', function (e) {
console.log('Upload error: ', e);
});
```

## Defaults and Configurables

* **concurrentParts** (Default: 5) - Parts that are uploaded simultaneously.
* **waitTime** (Default: 1 min (60000 ms)) - Time to wait for verification from S3 after uploading parts.
* **retries** (Default: 5) - Number of times to retry uploading a part, before failing.
* **maxPartSize** (Default: 5 MB) - Maximum size of each part.

## History

* v0.1.5 (2014-03-15) -- Added upload, download time and speed statistics.


## License
The MIT License (MIT)

Copyright (c) 2014 Talha Asad

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

0 comments on commit cafdc1f

Please sign in to comment.