# @types/s3-streams

> TypeScript definitions for s3-streams

Latest version **0.4.6** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/s3-streams
pnpm add @types/s3-streams
yarn add @types/s3-streams
bun add @types/s3-streams
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.4.6 |
| Published | 2023-11-07 |
| First published | 2020-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51370 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/s3-streams
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-streams
- npm.io page: https://npm.io/package/@types/s3-streams

## Dependencies (2)

- [@types/node](https://npm.io/package/@types/node.md) *
- [@types/aws-sdk2-types](https://npm.io/package/@types/aws-sdk2-types.md) *

## Recent versions

- 0.4.6 (latest) — 2023-11-07
- 0.4.3 (ts4.2) — 2023-01-30
- 0.4.2 (ts3.9) — 2022-04-19
- 0.4.1 (ts3.6) — 2021-07-06
- 0.4.0 (ts3.0) — 2020-08-10
- 0.4.5 — 2023-10-18
- 0.4.4 — 2023-09-25

## README

# Installation
> `npm install --save @types/s3-streams`

# Summary
This package contains type definitions for s3-streams (https://github.com/izaakschroeder/s3-streams).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-streams.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-streams/index.d.ts)
````ts
/// <reference types="node" />

import { S3 } from "aws-sdk2-types";
import { Readable, Writable } from "stream";

export interface StreamOptions {
    /**
     * Number of bytes to read or write before emitting a chunk to the stream.
     * Must be above 5MB for {@link WriteStream}
     *
     * @default 4MB for {@link ReadStream}
     * @default 10MB for {@link WriteStream}
     */
    highWaterMark?: number | undefined;
}

export class ReadStream extends Readable {
    constructor(client: S3, options: S3.GetObjectRequest, streamOptions?: StreamOptions);
}

export class WriteStream extends Writable {
    constructor(client: S3, options: S3.CreateMultipartUploadRequest, streamOptions?: StreamOptions);
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/aws-sdk2-types](https://npmjs.com/package/@types/aws-sdk2-types), [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Carl Fürstenberg](https://github.com/azatoth).

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