@zip.js/zip.js
    Preparing search index...

    Class ZipWriterStream

    Represents an instance used to create a zipped stream.

    This example creates a zipped file called numbers.txt.zip containing the numbers 0 - 1000 each on their own line.

    const readable = ReadableStream.from((function* () {
      for (let i = 0; i < 1000; ++i)
        yield i + '\n'
    })())

    readable
      .pipeThrough(new ZipWriterStream().transform('numbers.txt'))
      .pipeTo((await Deno.create('numbers.txt.zip')).writable)

    This example creates a zipped file called Archive.zip containing two files called numbers.txt and letters.txt

    const readable1 = ReadableStream.from((function* () {
      for (let i = 0; i < 1000; ++i)
        yield i + '\n'
    })())
    const readable2 = ReadableStream.from((function* () {
      const letters = 'abcdefghijklmnopqrstuvwxyz'.split('')
      while (letters.length)
        yield letters.shift() + '\n'
    })())

    const zipper = new ZipWriterStream()
    zipper.readable.pipeTo((await Deno.create('Archive.zip')).writable)
    readable1.pipeTo(zipper.writable('numbers.txt'))
    readable2.pipeTo(zipper.writable('letters.txt'))
    zipper.close()
    Index
    constructor
    readable zipWriter
    close transform writable
    readable: ReadableStream<Uint8Array<ArrayBufferLike>>

    The readable stream.

    zipWriter: ZipWriter<unknown>

    The ZipWriter property.

    • Writes the entries directory, writes the global comment, and returns the content of the zipped file.

      Parameters

      • Optionalcomment: Uint8Array<ArrayBufferLike>

        The global comment of the zip file.

      • Optionaloptions: ZipWriterCloseOptions

        The options.

      Returns Promise<unknown>

      The content of the zip file.

    • Returns an object containing a readable and writable property for the .pipeThrough method

      Type Parameters

      • T

      Parameters

      • path: string

        The name of the stream when unzipped. Paths must use forward slashes ("/") as separator (see ZipWriter#add).

      Returns { readable: ReadableStream<T>; writable: WritableStream<T> }

      An object containing readable and writable properties

    • Returns a WritableStream for the .pipeTo method

      Type Parameters

      • T

      Parameters

      • path: string

        The directory path of where the stream should exist in the zipped stream. Paths must use forward slashes ("/") as separator (see ZipWriter#add).

      Returns WritableStream<T>

      A WritableStream.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods