# s3-blob-store

> s3 abstract-blob-store

Latest version **4.1.1** (published 2020-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install s3-blob-store
pnpm add s3-blob-store
yarn add s3-blob-store
bun add s3-blob-store
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2020-02-14 |
| First published | 2014-09-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 67 |
| Maintainers | jb55 |
| Keywords | abstract-blob-store, blob-store, s3, blob |

## Links

- npm: https://www.npmjs.com/package/s3-blob-store
- Repository: https://github.com/jb55/s3-blob-store
- Homepage: https://github.com/jb55/s3-blob-store#readme
- Issues: https://github.com/jb55/s3-blob-store/issues
- npm.io page: https://npm.io/package/s3-blob-store

## Dependencies (4)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [mime-types](https://npm.io/package/mime-types.md) ^2.0.0
- [s3-stream-upload](https://npm.io/package/s3-stream-upload.md) ^2.0.1
- [s3-download-stream](https://npm.io/package/s3-download-stream.md) 1.1.1

## Recent versions

- 4.1.1 (latest) — 2020-02-14
- 4.1.0 — 2019-11-05
- 3.2.0 — 2018-03-11
- 3.1.0 — 2018-02-22
- 3.0.0 — 2018-02-08
- 2.1.0 — 2017-10-07
- 2.0.1 — 2017-06-19
- 1.2.3 — 2016-09-08
- 1.2.2 — 2016-09-08
- 1.2.1 — 2016-09-01
- 1.1.1 — 2016-03-31
- 1.0.0 — 2015-12-04
- 0.1.0 — 2015-10-20
- 0.0.6 — 2015-07-17
- 0.0.5 — 2015-02-10
- … 4 more at https://npm.io/package/s3-blob-store/versions

## README

# s3-blob-store [![build status](https://badgen.net/travis/jb55/s3-blob-store/master)](https://travis-ci.com/jb55/s3-blob-store) [![install size](https://badgen.net/packagephobia/install/s3-blob-store)](https://packagephobia.now.sh/result?p=s3-blob-store) [![npm package version](https://badgen.net/npm/v/s3-blob-store)](https://npm.im/s3-blob-store) [![github license](https://badgen.net/github/license/jb55/s3-blob-store)](https://github.com/jb55/s3-blob-store/blob/master/LICENSE) [![js semistandard style](https://badgen.net/badge/code%20style/semistandard/pink)](https://github.com/Flet/semistandard)

Amazon S3 [abstract-blob-store](http://npmrepo.com/abstract-blob-store)


[![blob-store-compatible](https://raw.githubusercontent.com/maxogden/abstract-blob-store/master/badge.png)](https://github.com/maxogden/abstract-blob-store)

## Installation

Install with npm

    $ npm install s3-blob-store

## Example

```js
var aws = require('aws-sdk');
var s3blobs = require('s3-blob-store');

var client = new aws.S3({
  accessKeyId: process.env.S3_ACCESS_KEY,
  secretAccessKey: process.env.S3_SECRET_KEY
});

var store = s3blobs({
  client: client,
  bucket: 'mybucket'
});

// write to s3
fs.createReadStream('/tmp/somefile.txt')
  .pipe(store.createWriteStream({ key: 'somefile.txt' }));

// read from s3
store.createReadStream({ key: 'somefile.txt' })
  .pipe(fs.createWriteStream('/tmp/somefile.txt'));

// exists
store.exists({ key: 'somefile.txt' }, function (err, exists) {
  // ...
});
```

## API

### `var s3 = require('s3-blob-store')(options)`

`options` must be an object that has the following properties:

- `client`: an `require('aws-sdk').S3` instance
- `bucket`: your bucket

### `s3.createWriteStream(opts, cb)`

returns a writable stream that you can pipe data to.

`opts` should be an object that has options `key` (will be the filename in
your bucket)

`opts.params` additional [parameters](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#putObject-property) to pass to S3

`cb` will be called with `(err)` if there is was an error

### `s3.createReadStream(opts)`

`opts` should be `{ key: string (usually a hash or path + filename) }`

`opts.params` additional [parameters](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#getObject-property) to pass to S3
`opts.concurrency` optional parameter for [s3-download-stream](https://github.com/jb55/s3-download-stream)
`opts.chunkSize` optional parameter for [s3-download-stream](https://github.com/jb55/s3-download-stream)

returns a readable stream of data for the file in your bucket whose key matches

## License

    The MIT License (MIT)

    Copyright (c) 2014 William Casarin

    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.

---
_Source: https://npm.io/package/s3-blob-store · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._