# image-steam-s3

> S3 client for Image Steam: https://github.com/asilvas/node-image-steam

Latest version **1.1.0** (published 2018-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install image-steam-s3
pnpm add image-steam-s3
yarn add image-steam-s3
bun add image-steam-s3
```

## 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 | 1.1.0 |
| Published | 2018-03-05 |
| First published | 2018-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Aaron Silvas |
| Maintainers | asilvas |

## Links

- npm: https://www.npmjs.com/package/image-steam-s3
- Repository: https://github.com/asilvas/image-steam-s3
- Homepage: https://github.com/asilvas/image-steam-s3#readme
- Issues: https://github.com/asilvas/image-steam-s3/issues
- npm.io page: https://npm.io/package/image-steam-s3

## Dependencies (2)

- [knox](https://npm.io/package/knox.md) ^0.9.2
- [once](https://npm.io/package/once.md) ^1.4.0

## Recent versions

- 1.1.0 (latest) — 2018-03-05
- 1.0.0 — 2018-02-27

## README

# image-steam-blobby
S3 client for [Image Steam](https://github.com/asilvas/node-image-steam).


## Options

```ecmascript 6
import isteamS3 from 'image-steam-s3';

const s3 = new isteamS3({
  endpoint: 's3.amazonaws.com',
  accessKey: 'myAccessKey',
  secretKey: 'mySecretShhh'
});
```

| Option | Type | Default | Info |
| --- | --- | --- | --- |
| endpoint | `string` | `"s3.amazonaws.com"` | Endpoint of S3 service |
| port | `number` | `443` | Non-443 port will auto-default secure to `false` |
| secure | `boolean` | `true` only if port `443` | Override as needed |
| accessKey | `string` | ***required*** | S3 access key |
| secretKey | `string` | ***required*** | S3 secret key |
| style | `string` | `"path"` | May use `virtualHosted` if bucket is not in path |
| bucket | `string` | *optional* | S3 Bucket |


## Usage

Example:

```ecmascript 6
import isteam from 'image-steam';

const options = {
  storage: {
    app: {
      static: {
        driver: 'http',
        endpoint: 'https://some-endpoint.com'
      }
    },
    cache: {
      driverPath: 'image-steam-s3',
      bucket: 'myBucket',
      accessKey: 'myAccessKey',
      secretKey: 'mySecretShh'
    }
  }
}

http.createServer(new isteam.http.Connect(options).getHandler())
  .listen(13337, '127.0.0.1')
;
```

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