# @types/s3-uploader

> TypeScript definitions for s3-uploader

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

## Install

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

## 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.0.32 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51446 |
| Maintainers | types |

## Links

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

## Recent versions

- 0.0.32 (latest) — 2023-11-07
- 0.0.29 (ts3.6) — 2021-07-06
- 0.0.28 (ts2.0) — 2017-06-05
- 0.0.31 — 2023-10-18
- 0.0.30 — 2023-09-25
- 0.0.27 — 2016-09-19
- 0.0.26 — 2016-07-14
- 0.0.25-alpha — 2016-07-08
- 0.0.24-alpha — 2016-07-04
- 0.0.23-alpha — 2016-07-02
- 0.0.22-alpha — 2016-07-01
- 0.0.21-alpha — 2016-07-01
- 0.0.20-alpha — 2016-05-25
- 0.0.19-alpha — 2016-05-20
- 0.0.14-alpha — 2016-05-19
- … 1 more at https://npm.io/package/@types/s3-uploader/versions

## README

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

# Summary
This package contains type definitions for s3-uploader (https://www.npmjs.com/package/s3-uploader).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-uploader.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-uploader/index.d.ts)
````ts
// NOTE: Does require GM (https://github.com/aheckmann/gm) thus requires GraphicsMagick (http://www.graphicsmagick.org/) or ImageMagick (http://www.imagemagick.org/)

export = Upload;

declare namespace Upload {
    interface S3UploaderVersion {
        original?: boolean | undefined;
        suffix?: string | undefined;
        quality?: number | undefined;
        maxWidth?: number | undefined;
        maxHeight?: number | undefined;
    }

    interface S3UploaderOptions {
        awsAccessKeyId?: string | undefined;
        awsSecretAccessKey?: string | undefined;
        awsBucketRegion?: string | undefined;
        awsBucketPath?: string | undefined;
        awsBucketAcl?: string | undefined;
        awsMaxRetries?: number | undefined;
        awsHttpTimeout?: number | undefined;
        resizeQuality?: number | undefined;
        returnExif?: boolean | undefined;
        tmpDir?: string | undefined;
        workers?: number | undefined;
        url?: string | undefined;
        versions?: S3UploaderVersion[] | undefined;
    }

    interface Meta {
        format: string;
        fileSize: string;
        imageSize: imageSize;
        orientation: string;
        colorSpace: string;
        compression: string;
        quallity: string;
    }

    interface imageSize {
        height: number;
        width: number;
    }

    interface image {
        etag: string;
        format: string;
        height: number;
        original: boolean;
        path: string;
        size: string;
        src: string;
        url: string;
        width: number;
    }
}

declare class Upload {
    public constructor(awsBucketName: string, opts: Upload.S3UploaderOptions);

    public upload(
        src: string,
        opts?: Upload.S3UploaderOptions,
        cb?: (err: string, images: Upload.image[], meta: Upload.Meta) => void,
    ): void;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [COLSA Corporation](http://www.colsa.com/).

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