@types/unzipper
- Version 0.10.11
- Published
- 6.38 kB
- 1 dependency
- MIT license
Install
npm i @types/unzipper
yarn add @types/unzipper
pnpm add @types/unzipper
Overview
TypeScript definitions for unzipper
Index
Functions
Interfaces
File
- buffer
- comment
- compressedSize
- compressionMethod
- crc32
- diskNumber
- externalFileAttributes
- extra
- extraFieldLength
- fileCommentLength
- fileNameLength
- flags
- internalFileAttributes
- isUnicode
- lastModifiedDate
- lastModifiedDateTime
- lastModifiedTime
- offsetToLocalFileHeader
- path
- pathBuffer
- signature
- stream
- type
- uncompressedSize
- versionMadeBy
- versionsNeededToExtract
Type Aliases
Namespaces
Functions
function BufferStream
BufferStream: (entry: Entry) => Promise<Buffer>;
function Extract
Extract: (opts?: ParseOptions) => ParseStream;
function Parse
Parse: (opts?: ParseOptions) => ParseStream;
function ParseOne
ParseOne: (match?: RegExp, opts?: ParseOptions) => Duplex;
function unzip
unzip: ( source: { stream: Readable; size: () => Promise<number> }, offset: number, _password: string) => Entry;
Interfaces
interface CentralDirectory
interface CentralDirectory {}
property commentLength
commentLength: number;
property diskNumber
diskNumber: number;
property diskStart
diskStart: number;
property extract
extract: (opts: ParseOptions) => Promise<void>;
property files
files: File[];
property numberOfRecords
numberOfRecords: number;
property numberOfRecordsOnDisk
numberOfRecordsOnDisk: number;
property offsetToStartOfCentralDirectory
offsetToStartOfCentralDirectory: number;
property signature
signature: number;
property sizeOfCentralDirectory
sizeOfCentralDirectory: number;
interface Entry
interface Entry extends PassThrough {}
property extra
extra: { signature: number; partsize: number; uncompressedSize: number; compressedSize: number; offset: number; disknum: number;};
property path
path: string;
property props
props: { path: string;};
property type
type: string;
property vars
vars: { signature?: number | undefined; versionsNeededToExtract: number; flags: number; compressionMethod: number; lastModifiedTime: number; crc32: number; compressedSize: number; fileNameLength: number; extraFieldLength: number;};
method autodrain
autodrain: () => Transform & { promise(): Promise<void> };
method buffer
buffer: () => Promise<Buffer>;
interface File
interface File {}
property buffer
buffer: (password?: string) => Promise<Buffer>;
property comment
comment: string;
property compressedSize
compressedSize: number;
property compressionMethod
compressionMethod: number;
property crc32
crc32: number;
property diskNumber
diskNumber: number;
property externalFileAttributes
externalFileAttributes: number;
property extra
extra: any;
property extraFieldLength
extraFieldLength: number;
property fileCommentLength
fileCommentLength: number;
property fileNameLength
fileNameLength: number;
property flags
flags: number;
property internalFileAttributes
internalFileAttributes: number;
property isUnicode
isUnicode: number;
property lastModifiedDate
lastModifiedDate: number;
property lastModifiedDateTime
lastModifiedDateTime: Date;
property lastModifiedTime
lastModifiedTime: number;
property offsetToLocalFileHeader
offsetToLocalFileHeader: number;
property path
path: string;
property pathBuffer
pathBuffer: Buffer;
property signature
signature: number;
property stream
stream: (password?: string) => Entry;
property type
type: 'Directory' | 'File';
property uncompressedSize
uncompressedSize: number;
property versionMadeBy
versionMadeBy: number;
property versionsNeededToExtract
versionsNeededToExtract: number;
interface ParseOptions
interface ParseOptions {}
property concurrency
concurrency?: number | undefined;
property forceStream
forceStream?: boolean | undefined;
property path
path?: string | undefined;
property verbose
verbose?: boolean | undefined;
interface PullStream
interface PullStream extends Duplex {}
Type Aliases
type ParseStream
type ParseStream = PullStream & { promise(): Promise<void>;};
Namespaces
namespace Open
namespace Open {}
function buffer
buffer: (data: Buffer) => Promise<CentralDirectory>;
function custom
custom: (source: { size: () => Promise<number>; stream: (offset: number, length: number) => Readable;}) => Promise<CentralDirectory>;
function file
file: (filename: string) => Promise<CentralDirectory>;
function s3
s3: (client: any, params: any) => Promise<CentralDirectory>;
function s3_v3
s3_v3: (client: any, params: any) => Promise<CentralDirectory>;
function url
url: ( request: ClientRequest, opt: string | RequestOptions) => Promise<CentralDirectory>;
Package Files (1)
Dependencies (1)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/unzipper
.
- Markdown[](https://www.jsdocs.io/package/@types/unzipper)
- HTML<a href="https://www.jsdocs.io/package/@types/unzipper"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3401 ms. - Missing or incorrect documentation? Open an issue for this package.