# @sensejs/multipart-s3-adaptor

> This package, `@sensejs/multipart-s3-adaptor`, provides an experimental S3 storage adaptor for `@sensejs/multipart`, based on the official AWS SDK v3 for Javascript.

Latest version **0.11.4** (published 2023-12-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @sensejs/multipart-s3-adaptor
pnpm add @sensejs/multipart-s3-adaptor
yarn add @sensejs/multipart-s3-adaptor
bun add @sensejs/multipart-s3-adaptor
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.11.4 |
| Published | 2023-12-19 |
| First published | 2023-05-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 258.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | LAN Xingcan |
| Maintainers | thynson |

## Links

- npm: https://www.npmjs.com/package/@sensejs/multipart-s3-adaptor
- npm.io page: https://npm.io/package/@sensejs/multipart-s3-adaptor

## Dependencies (1)

- [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.470.0

## Recent versions

- 0.11.4 (latest) — 2023-12-19
- 0.11.3 — 2023-12-11
- 0.11.2 — 2023-05-11
- 0.11.1 — 2023-05-11

## README

# The S3 Storage Adaptor for `@sensejs/multipart` (experimental)

This package, `@sensejs/multipart-s3-adaptor`, provides an experimental S3 storage adaptor
for `@sensejs/multipart`, based on the official AWS SDK v3 for Javascript.


## Usage

```typescript
const [multipart, cleanup] = Multipart.from(req, req.headers);

try {
  const records = await multipart.read(new MultipartFileRemoteStorage(new S3StorageAdaptor({
    s3Config: {
      // Your S3 config
    },
    s3Bucket: 'you-s3-bucket-name',
    getFileKey: (name, info) => {
      // Return the key of the file in S3
      return `${maybeSomePrefix}/${name}`;
    },
  })));
} finally {
  // It will invoke the cleanup method provided by your adaptor
  await cleanup();
}
```

Consult documentation comments of `S3StorageAdaptorOptions` for more detail.

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