Installation

npm install --save @types/yazl

Summary

This package contains type definitions for yazl (https://github.com/thejoshwolfe/yazl).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yazl.

index.d.ts

// Type definitions for yazl 2.4
// Project: https://github.com/thejoshwolfe/yazl
// Definitions by: taoqf <https://github.com/taoqf>
//                 Sean Marvi Oliver Genabe <https://github.com/seangenabe>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1

/// <reference types="node" />

import { Buffer } from "buffer";

export interface Options {
    mtime: Date;
    mode: number;
    compress: boolean;
    forceZip64Format: boolean;
}

export interface ReadStreamOptions extends Options {
    size: number;
}

export interface DirectoryOptions {
    mtime: Date;
    mode: number;
}

export interface EndOptions {
    forceZip64Format: boolean;
}

export interface DosDateTime {
    date: number;
    time: number;
}

export class ZipFile {
    addFile(realPath: string, metadataPath: string, options?: Partial<Options>): void;
    outputStream: NodeJS.ReadableStream;
    addReadStream(input: NodeJS.ReadableStream, metadataPath: string, options?: Partial<ReadStreamOptions>): void;
    addBuffer(buffer: Buffer, metadataPath: string, options?: Partial<Options>): void;
    end(options?: EndOptions, finalSizeCallback?: () => void): void;

    addEmptyDirectory(metadataPath: string, options?: Partial<DirectoryOptions>): void;
    dateToDosDateTime(jsDate: Date): DosDateTime;
}

Additional Details

Last updated: Mon, 25 Sep 2023 05:35:36 GMT
Dependencies: @types/node
Global values: none

Credits

These definitions were written by taoqf, and Sean Marvi Oliver Genabe.

Current Tags

4 Versions

2.4.3 ... 3 years ago
2.4.2 ... 7 years ago
2.4.1 ... 7 years ago
2.4.0 ... 8 years ago