Installation
npm install --save @types/s3-zip
Summary
This package contains type definitions for s3-zip (https://github.com/orangewise/s3-zip).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-zip.
index.d.ts
import { S3Client } from "@aws-sdk/client-s3";
import { Archiver, ArchiverOptions, EntryData, Format } from "archiver";
declare namespace S3Zip {
interface ArchiveOptions {
s3?: S3Client;
region?: string;
bucket: string;
debug?: boolean;
preserveFolderStructure?: boolean;
}
}
interface S3Zip {
archive(
opts: S3Zip.ArchiveOptions,
folder: string | undefined,
filesS3: string[],
filesZip?: EntryData[],
): Archiver;
setFormat(format: Format): this;
setArchiverOptions(archiverOpts: ArchiverOptions): this;
// eslint-disable-next-line @typescript-eslint/ban-types -- Function
setRegisterFormatOptions(registerFormat: string, formatModule: Function): this;
}
declare const S3Zip: S3Zip;
export = S3Zip;
Additional Details
- Last updated: Mon, 18 Dec 2023 01:31:27 GMT
- Dependencies: @aws-sdk/client-s3, @types/archiver
Credits
These definitions were written by Janick.