Class ZipFileEntry<ReaderType, WriterType>

Represents a file entry in the zip (Filesystem API).

Type Parameters

  • ReaderType
  • WriterType

Hierarchy (View Summary)

Constructors

constructor

Properties

children data? directory id name parent? reader uncompressedSize writer

Methods

checkPassword clone getBlob getData getData64URI getFullname getRelativeName getText getUint8Array getWritable isDescendantOf isPasswordProtected rename replaceBlob replaceData64URI replaceReadable replaceText replaceUint8Array

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

Optionaldata

data?: EntryMetaData

The underlying EntryMetaData instance.

directory

directory: void

void for ZipFileEntry instances.

id

id: number

The ID of the instance.

name

name: string

The relative filename of the entry.

Optionalparent

parent?: ZipEntry

The parent directory of the entry.

reader

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

The Reader instance used to read the content of the entry.

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

writer

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

The Writer instance used to write the content of the entry.

Methods

checkPassword

clone

getBlob

  • getBlob(mimeType?: string, options?: EntryGetDataOptions): Promise<Blob>

  • Retrieves the content of the entry as a Blob instance

    Parameters

    • OptionalmimeType: string

      The MIME type of the content.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<Blob>

    A promise resolving to a Blob instance.

getData

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

  • Retrieves the content of the entry via a Writer instance

    Parameters

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

      The Writer instance.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<unknown>

    A promise resolving to data associated to the Writer instance.

getData64URI

  • getData64URI(mimeType?: string, options?: EntryGetDataOptions): Promise<string>

  • Retrieves the content of the entry as as a Data URI string encoded in Base64

    Parameters

    • OptionalmimeType: string

      The MIME type of the content.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<string>

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

getFullname

getRelativeName

getText

  • getText(encoding?: string, options?: EntryGetDataOptions): Promise<string>

  • Retrieves the text content of the entry as a string

    Parameters

    • Optionalencoding: string

      The encoding of the text.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<string>

    A promise resolving to a string.

getUint8Array

  • getUint8Array(
        options?: EntryGetDataOptions,
    ): Promise<Uint8Array<ArrayBufferLike>>

  • Retrieves the content of the entry as a Uint8Array instance

    Parameters

    Returns Promise<Uint8Array<ArrayBufferLike>>

    A promise resolving to a Uint8Array instance.

getWritable

  • getWritable(
        writable?: WritableStream<any>,
        options?: EntryGetDataOptions,
    ): Promise<WritableStream<any>>

  • Retrieves the content of the entry via a WritableStream instance

    Parameters

    • Optionalwritable: WritableStream<any>

      The WritableStream instance.

    • Optionaloptions: EntryGetDataOptions

      The options.

    Returns Promise<WritableStream<any>>

    A promise resolving to the WritableStream instance.

isDescendantOf

isPasswordProtected

rename

  • rename(name: string): void

  • Set the name of the entry

    Parameters

    • name: string

      The new name of the entry.

    Returns void

replaceBlob

  • replaceBlob(blob: Blob): void

  • Replaces the content of the entry with a Blob instance

    Parameters

    • blob: Blob

      The Blob instance.

    Returns void

replaceData64URI

  • replaceData64URI(dataURI: string): void

  • Replaces the content of the entry with a Data URI string encoded in Base64

    Parameters

    • dataURI: string

      The Data URI string encoded in Base64.

    Returns void

replaceReadable

  • replaceReadable(readable: ReadableStream<any>): void

  • Replaces the content of the entry with a ReadableStream instance

    Parameters

    • readable: ReadableStream<any>

      The ReadableStream instance.

    Returns void

replaceText

  • replaceText(text: string): void

  • Replaces the content of the entry with a string

    Parameters

    • text: string

      The string.

    Returns void

replaceUint8Array

  • replaceUint8Array(array: Uint8Array<ArrayBufferLike>): void

  • Replaces the content of the entry with a Uint8Array instance

    Parameters

    • array: Uint8Array<ArrayBufferLike>

      The Uint8Array instance.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods