@types/yauzl
- Version 3.4.0
- Published
- 9.18 kB
- 1 dependency
- MIT license
Install
npm i @types/yauzlyarn add @types/yauzlpnpm add @types/yauzlOverview
TypeScript definitions for yauzl
Index
Functions
Classes
Entry
- canDecodeFileData()
- comment
- compressedSize
- compressionMethod
- crc32
- externalFileAttributes
- extraFieldLength
- extraFieldRaw
- extraFields
- fileComment
- fileCommentLength
- fileCommentRaw
- fileName
- fileNameLength
- fileNameRaw
- generalPurposeBitFlag
- getLastModDate()
- internalFileAttributes
- isCompressed()
- isEncrypted()
- lastModFileDate
- lastModFileTime
- relativeOffsetOfLocalHeader
- uncompressedSize
- versionMadeBy
- versionNeededToExtract
Interfaces
Functions
function dosDateTimeToDate
dosDateTimeToDate: (date: number, time: number) => Date;Deprecated
Use
entry.getLastModDate()instead.
function fromBuffer
fromBuffer: { ( buffer: Buffer, options: Options, callback?: (err: Error | null, zipfile: ZipFile) => void ): void; (buffer: Buffer, callback?: (err: Error, zipfile: ZipFile) => void): void;};function fromBufferPromise
fromBufferPromise: (buffer: Buffer, options?: Options) => Promise<ZipFile>;function fromFd
fromFd: { ( fd: number, options: Options, callback?: (err: Error | null, zipfile: ZipFile) => void ): void; (fd: number, callback?: (err: Error, zipfile: ZipFile) => void): void;};function fromFdPromise
fromFdPromise: (fd: number, options?: Options) => Promise<ZipFile>;function fromRandomAccessReader
fromRandomAccessReader: { ( reader: RandomAccessReader, totalSize: number, options: Options, callback: (err: Error | null, zipfile: ZipFile) => void ): void; ( reader: RandomAccessReader, totalSize: number, callback: (err: Error, zipfile: ZipFile) => void ): void;};function fromRandomAccessReaderPromise
fromRandomAccessReaderPromise: ( reader: RandomAccessReader, totalSize: number, options?: Options) => Promise<ZipFile>;function getFileNameLowLevel
getFileNameLowLevel: ( generalPurposeBitFlag: number, fileNameBuffer: Buffer, extraFields: ExtraField[], strictFileNames: boolean) => string;function open
open: { ( path: string, options: Options, callback?: (err: Error | null, zipfile: ZipFile) => void ): void; (path: string, callback?: (err: Error, zipfile: ZipFile) => void): void;};function openPromise
openPromise: (path: string, options?: Options) => Promise<ZipFile>;function parseExtraFields
parseExtraFields: (extraFieldBuffer: Buffer) => ExtraField[];function validateFileName
validateFileName: (fileName: string) => string | null;Classes
class Entry
class Entry {}property comment
comment: string;property compressedSize
compressedSize: number;property compressionMethod
compressionMethod: number;property crc32
crc32: number;property externalFileAttributes
externalFileAttributes: number;property extraFieldLength
extraFieldLength: number;property extraFieldRaw
extraFieldRaw: Buffer;property extraFields
extraFields: ExtraField[];property fileComment
fileComment: string;property fileCommentLength
fileCommentLength: number;property fileCommentRaw
fileCommentRaw: Buffer;property fileName
fileName: string;property fileNameLength
fileNameLength: number;property fileNameRaw
fileNameRaw: Buffer;property generalPurposeBitFlag
generalPurposeBitFlag: number;property internalFileAttributes
internalFileAttributes: number;property lastModFileDate
lastModFileDate: number;property lastModFileTime
lastModFileTime: number;property relativeOffsetOfLocalHeader
relativeOffsetOfLocalHeader: number;property uncompressedSize
uncompressedSize: number;property versionMadeBy
versionMadeBy: number;property versionNeededToExtract
versionNeededToExtract: number;method canDecodeFileData
canDecodeFileData: () => boolean;method getLastModDate
getLastModDate: (options?: GetLastModDateOptions) => Date;method isCompressed
isCompressed: () => boolean;Deprecated
Use
canDecodeFileData()and/or checkcompressionMethod.
method isEncrypted
isEncrypted: () => boolean;class LocalFileHeader
class LocalFileHeader {}property compressedSize
compressedSize: number;property compressionMethod
compressionMethod: number;property crc32
crc32: number;property extraField
extraField: Buffer;property extraFieldLength
extraFieldLength: number;property fileDataStart
fileDataStart: number;property fileName
fileName: Buffer;property fileNameLength
fileNameLength: number;property generalPurposeBitFlag
generalPurposeBitFlag: number;property lastModFileDate
lastModFileDate: number;property lastModFileTime
lastModFileTime: number;property uncompressedSize
uncompressedSize: number;property versionNeededToExtract
versionNeededToExtract: number;class RandomAccessReader
abstract class RandomAccessReader extends EventEmitter {}method close
close: (callback: (err: Error | null) => void) => void;method createReadStream
createReadStream: (options: { start: number; end: number }) => Readable;method read
read: ( buffer: Buffer, offset: number, length: number, position: number, callback: (err: Error | null) => void) => void;class ZipFile
class ZipFile extends EventEmitter {}constructor
constructor( reader: RandomAccessReader, centralDirectoryOffset: number, fileSize: number, entryCount: number, comment: string, autoClose: boolean, lazyEntries: boolean, decodeStrings: boolean, validateEntrySizes: boolean);property autoClose
autoClose: boolean;property comment
comment: string;property decodeStrings
decodeStrings: boolean;property emittedError
emittedError: boolean;property entriesRead
entriesRead: number;property entryCount
entryCount: number;property fileSize
fileSize: number;property isOpen
isOpen: boolean;property lazyEntries
lazyEntries: boolean;property readEntryCursor
readEntryCursor: boolean;property validateEntrySizes
validateEntrySizes: boolean;method close
close: () => void;method eachEntry
eachEntry: () => AsyncIterableIterator<Entry>;method openReadStream
openReadStream: { ( entry: Entry, options: ZipFileOptions, callback: (err: Error | null, stream: Readable) => void ): void; (entry: Entry, callback: (err: Error, stream: Readable) => void): void;};method openReadStreamLowLevel
openReadStreamLowLevel: ( fileDataStart: number, compressedSize: number, relativeStart: number, relativeEnd: number, decompress: boolean, uncompressedSize: number | null, callback: (err: Error | null, stream: Readable) => void) => void;method openReadStreamLowLevelPromise
openReadStreamLowLevelPromise: ( fileDataStart: number, compressedSize: number, relativeStart: number, relativeEnd: number, decompress: boolean, uncompressedSize: number | null) => Promise<Readable>;method openReadStreamPromise
openReadStreamPromise: ( entry: Entry, options?: ZipFileOptions) => Promise<Readable>;method readEntry
readEntry: () => void;method readLocalFileHeader
readLocalFileHeader: { ( entry: Entry, options: { minimal: true }, callback: (err: Error | null, header: { fileDataStart: number }) => void ): void; ( entry: Entry, options: { minimal?: boolean }, callback: (err: Error, header: LocalFileHeader) => void ): void; ( entry: Entry, callback: (err: Error, header: LocalFileHeader) => void ): void;};method readLocalFileHeaderPromise
readLocalFileHeaderPromise: { (entry: Entry, options: { minimal: true }): Promise<{ fileDataStart: number; }>; (entry: Entry, options?: { minimal?: boolean }): Promise<LocalFileHeader>;};Interfaces
interface ExtraField
interface ExtraField {}interface GetLastModDateOptions
interface GetLastModDateOptions {}property forceDosFormat
forceDosFormat?: boolean | undefined;property timezone
timezone?: 'local' | 'UTC' | null | undefined;interface Options
interface Options {}property autoClose
autoClose?: boolean | undefined;property decodeStrings
decodeStrings?: boolean | undefined;property lazyEntries
lazyEntries?: boolean | undefined;property strictFileNames
strictFileNames?: boolean | undefined;property validateEntrySizes
validateEntrySizes?: boolean | undefined;interface ZipFileOptions
interface ZipFileOptions {}property decodeFileData
decodeFileData?: boolean | null | undefined;property decompress
decompress?: boolean | null | undefined;Deprecated
property decrypt
decrypt?: boolean | null | undefined;Deprecated
property end
end?: number | null | undefined;property start
start?: number | null | undefined;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/yauzl.
- Markdown[](https://www.jsdocs.io/package/@types/yauzl)
- HTML<a href="https://www.jsdocs.io/package/@types/yauzl"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3114 ms. - Missing or incorrect documentation? Open an issue for this package.
