Class ZipDirectoryEntry

constructor

• new ZipDirectoryEntry(): ZipDirectoryEntry

• Returns ZipDirectoryEntry

directory

addBlob

• addBlob(
      name: string,
      blob: Blob,
      options?: ZipWriterAddDataOptions,
  ): ZipFileEntry<Blob, Blob>

• Adds a entry entry with content provided as a Blob instance

  Parameters

  • name: string

    The relative filename of the entry.
  • blob: Blob

    The Blob instance.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns ZipFileEntry<Blob, Blob>

  A ZipFileEntry instance.

addData64URI

• addData64URI(
      name: string,
      dataURI: string,
      options?: ZipWriterAddDataOptions,
  ): ZipFileEntry<string, string>

• Adds a entry entry with content provided as a Data URI string encoded in Base64

  Parameters

  • name: string

    The relative filename of the entry.
  • dataURI: string

    The Data URI string encoded in Base64.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns ZipFileEntry<string, string>

  A ZipFileEntry instance.

addDirectory

• addDirectory(name: string, options?: ZipWriterAddDataOptions): ZipDirectoryEntry

• Adds a directory

  Parameters

  • name: string

    The relative filename of the directory.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns ZipDirectoryEntry

  A ZipDirectoryEntry instance.

addFile

• addFile(file: File, options?: ZipWriterAddDataOptions): Promise<ZipEntry>

• Adds an entry with content provided via a File instance

  Parameters

  • file: File

    The File instance.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns Promise<ZipEntry>

  A promise resolving to a ZipFileEntry or a ZipDirectoryEntry instance.

addFileSystemEntry

• addFileSystemEntry(
      fileSystemEntry: FileSystemEntryLike,
      options?: ZipWriterAddDataOptions,
  ): Promise<ZipEntry[]>

• Adds an entry with content provided via a FileSystemEntry instance

  Parameters

  • fileSystemEntry: FileSystemEntryLike

    The FileSystemEntry instance.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns Promise<ZipEntry[]>

  A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.

addFileSystemHandle

• addFileSystemHandle(
      fileSystemHandle: FileSystemHandleLike,
      options?: ZipWriterAddDataOptions,
  ): Promise<ZipEntry[]>

• Adds an entry with content provided via a FileSystemHandle instance

  Parameters

  • fileSystemHandle: FileSystemHandleLike

    The fileSystemHandle instance.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns Promise<ZipEntry[]>

  A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.

addHttpContent

• addHttpContent(
      name: string,
      url: string,
      options?: HttpOptions & ZipWriterAddDataOptions,
  ): ZipFileEntry<string, void>

• Adds an entry with content fetched from a URL

  Parameters

  • name: string

    The relative filename of the entry.
  • url: string

    The URL.
  • Optionaloptions: HttpOptions & ZipWriterAddDataOptions

    The options.

  Returns ZipFileEntry<string, void>

  A ZipFileEntry instance.

addReadable

• addReadable(
      name: string,
      readable: ReadableStream<any>,
      options?: ZipWriterAddDataOptions,
  ): ZipFileEntry<ReadableStream<any>, void>

• Adds a entry entry with content provided via a ReadableStream instance

  Parameters

  • name: string

    The relative filename of the entry.
  • readable: ReadableStream<any>

    The ReadableStream instance.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns ZipFileEntry<ReadableStream<any>, void>

  A ZipFileEntry instance.

addText

• addText(
      name: string,
      text: string,
      options?: ZipWriterAddDataOptions,
  ): ZipFileEntry<string, string>

• Adds an entry with content provided as text

  Parameters

  • name: string

    The relative filename of the entry.
  • text: string

    The text.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns ZipFileEntry<string, string>

  A ZipFileEntry instance.

addUint8Array

• addUint8Array(
      name: string,
      array: Uint8Array<ArrayBufferLike>,
      options?: ZipWriterAddDataOptions,
  ): ZipFileEntry<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>

• Adds an entry with content provided as a Uint8Array instance

  Parameters

  • name: string

    The relative filename of the entry.
  • array: Uint8Array<ArrayBufferLike>

    The Uint8Array instance.
  • Optionaloptions: ZipWriterAddDataOptions

    The options.

  Returns ZipFileEntry<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>

  A ZipFileEntry instance.

exportBlob

• exportBlob(options?: ZipDirectoryEntryExportOptions): Promise<Blob>

• Returns a Blob instance containing a zip file of the entry and its descendants

  Parameters

  • Optionaloptions: ZipDirectoryEntryExportOptions

    The options.

  Returns Promise<Blob>

  A promise resolving to the Blob instance.

exportData64URI

• exportData64URI(options?: ZipDirectoryEntryExportOptions): Promise<string>

• Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants

  Parameters

  • Optionaloptions: ZipDirectoryEntryExportOptions

    The options.

  Returns Promise<string>

  A promise resolving to the Data URI string encoded in Base64.

exportUint8Array

• exportUint8Array(
      options?: ZipDirectoryEntryExportOptions,
  ): Promise<Uint8Array<ArrayBufferLike>>

• Returns a Uint8Array instance containing a zip file of the entry and its descendants

  Parameters

  • Optionaloptions: ZipDirectoryEntryExportOptions

    The options.

  Returns Promise<Uint8Array<ArrayBufferLike>>

  A promise resolving to the Uint8Array instance.

exportWritable

• exportWritable(
      writable?: WritableStream<any>,
      options?: ZipDirectoryEntryExportOptions,
  ): Promise<WritableStream<any>>

• Creates a zip file via a WritableStream instance containing the entry and its descendants

  Parameters

  • Optionalwritable: WritableStream<any>

    The WritableStream instance.
  • Optionaloptions: ZipDirectoryEntryExportOptions

    The options.

  Returns Promise<WritableStream<any>>

  A promise resolving to the Uint8Array instance.

exportZip

• exportZip(
      writer:
          | WritableStream<any>
          | WritableWriter
          | Writer<unknown>
          | AsyncGenerator<
              WritableStream<any>
              | WritableWriter
              | Writer<unknown>,
              any,
              any,
          >,
      options?: ZipDirectoryEntryExportOptions,
  ): Promise<unknown>

• Creates a zip file via a custom Writer instance containing the entry and its descendants

  Parameters

  • writer:
        | WritableStream<any>
        | WritableWriter
        | Writer<unknown>
        | AsyncGenerator<
            WritableStream<any>
            | WritableWriter
            | Writer<unknown>,
            any,
            any,
        >

    The Writer instance.
  • Optionaloptions: ZipDirectoryEntryExportOptions

    The options.

  Returns Promise<unknown>

  A promise resolving to the data.

getChildByName

• getChildByName(name: string): ZipEntry

• Gets a ZipEntry child instance from its relative filename

  Parameters

  • name: string

    The relative filename.

  Returns ZipEntry

  A ZipFileEntry or a ZipDirectoryEntry instance (use the ZipFileEntry#directory and ZipDirectoryEntry#directory properties to differentiate entries).

importBlob

• importBlob(
      blob: Blob,
      options?: ZipReaderConstructorOptions,
  ): Promise<[ZipEntry]>

• Extracts a zip file provided as a Blob instance into the entry

  Parameters

  • blob: Blob

    The Blob instance.
  • Optionaloptions: ZipReaderConstructorOptions

    The options.

  Returns Promise<[ZipEntry]>

importData64URI

• importData64URI(
      dataURI: string,
      options?: ZipReaderConstructorOptions,
  ): Promise<[ZipEntry]>

• Extracts a zip file provided as a Data URI string encoded in Base64 into the entry

  Parameters

  • dataURI: string

    The Data URI string encoded in Base64.
  • Optionaloptions: ZipReaderConstructorOptions

    The options.

  Returns Promise<[ZipEntry]>

importHttpContent

• importHttpContent(
      url: string,
      options?: ZipDirectoryEntryImportHttpOptions,
  ): Promise<[ZipEntry]>

• Extracts a zip file fetched from a URL into the entry

  Parameters

  • url: string

    The URL.
  • Optionaloptions: ZipDirectoryEntryImportHttpOptions

    The options.

  Returns Promise<[ZipEntry]>

importReadable

• importReadable(
      readable: ReadableStream<any>,
      options?: ZipReaderConstructorOptions,
  ): Promise<[ZipEntry]>

• Extracts a zip file provided via a ReadableStream instance into the entry

  Parameters

  • readable: ReadableStream<any>

    The ReadableStream instance.
  • Optionaloptions: ZipReaderConstructorOptions

    The options.

  Returns Promise<[ZipEntry]>

importUint8Array

• importUint8Array(
      array: Uint8Array<ArrayBufferLike>,
      options?: ZipReaderConstructorOptions,
  ): Promise<[ZipEntry]>

• Extracts a zip file provided as a Uint8Array instance into the entry

  Parameters

  • array: Uint8Array<ArrayBufferLike>

    The Uint8Array instance.
  • Optionaloptions: ZipReaderConstructorOptions

    The options.

  Returns Promise<[ZipEntry]>

importZip

• importZip(
      reader:
          | ReadableStream<any>
          | ReadableReader
          | Reader<unknown>
          | Reader<unknown>[]
          | ReadableReader[]
          | ReadableStream<any>[],
      options?: ZipReaderConstructorOptions,
  ): Promise<[ZipEntry]>

• Extracts a zip file provided via a custom Reader instance into the entry

  Parameters

  • reader:
        | ReadableStream<any>
        | ReadableReader
        | Reader<unknown>
        | Reader<unknown>[]
        | ReadableReader[]
        | ReadableStream<any>[]

    The Reader instance.
  • Optionaloptions: ZipReaderConstructorOptions

    The options.

  Returns Promise<[ZipEntry]>