Class ZipFileEntry<ReaderType, WriterType>

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

Type Parameters

ReaderType
WriterType

Hierarchy (View Summary)

ZipEntry
- ZipFileEntry

Constructors

constructor

new ZipFileEntry<ReaderType, WriterType>(): ZipFileEntry<ReaderType, WriterType>
Type Parameters
- ReaderType
- WriterType
Returns ZipFileEntry<ReaderType, WriterType>
Inherited from ZipEntry.constructor

Properties

children

children: ZipEntry[]

The children of the entry.

`Optional`data

data?: EntryMetaData

The underlying EntryMetaData instance.

id

id: number

The ID of the instance.

name

name: string

The relative filename of the entry.

`Optional`parent

parent?: ZipEntry

The parent directory of the entry.

reader

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

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

writer

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

Methods

checkPassword

checkPassword(password: string, options?: EntryGetDataOptions): Promise<boolean>
Tests the password on the entry and all children if any, returns true if the entry is not password protected
Parameters
- password: string
- Optionaloptions: EntryGetDataOptions
Returns Promise<boolean>
Inherited from ZipEntry.checkPassword
- Defined in index.d.ts:1735

clone

clone(deepClone?: boolean): ZipEntry
Clones the entry
Parameters
- OptionaldeepClone: boolean
  true to clone all the descendants.
Returns ZipEntry
Inherited from ZipEntry.clone
- Defined in index.d.ts:1713

getArrayBuffer

getArrayBuffer(options?: EntryGetDataOptions): Promise<ArrayBuffer>
Retrieves the content of the entry as an ArrayBuffer instance
Parameters
- Optionaloptions: EntryGetDataOptions
  The options.
Returns Promise<ArrayBuffer>
A promise resolving to an ArrayBuffer instance.
- Defined in index.d.ts:1839

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.
- Defined in index.d.ts:1788

getData

getData<Type>(
    writer:
        | WritableStream<any>
        | WritableWriter
        | Writer<unknown>
        | AsyncGenerator<
            WritableStream<any>
            | WritableWriter
            | Writer<unknown>,
            any,
            any,
        >,
    options?: EntryGetDataOptions,
): Promise<Type>
Retrieves the content of the entry via a Writer instance
Type Parameters
- Type
Parameters
- writer:
      | WritableStream<any>
      | WritableWriter
      | Writer<unknown>
      | AsyncGenerator<
          WritableStream<any>
          | WritableWriter
          | Writer<unknown>,
          any,
          any,
      >
  The Writer instance.
- Optionaloptions: EntryGetDataOptions
  The options.
Returns Promise<Type>
A promise resolving to data associated to the Writer instance.
- Defined in index.d.ts:1825

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.
- Defined in index.d.ts:1796

getFullname

getFullname(): string
Returns the full filename of the entry

Returns string
Inherited from ZipEntry.getFullname
- Defined in index.d.ts:1717

getRelativeName

getRelativeName(ancestor: ZipDirectoryEntry): string
Returns the filename of the entry relative to a parent directory
Parameters
- ancestor: ZipDirectoryEntry
Returns string
Inherited from ZipEntry.getRelativeName
- Defined in index.d.ts:1721

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.
- Defined in index.d.ts:1780

getUint8Array

getUint8Array(
options?: EntryGetDataOptions,
): Promise<Uint8Array<ArrayBufferLike>>
Retrieves the content of the entry as a Uint8Array instance
Parameters
- Optionaloptions: EntryGetDataOptions
  The options.
Returns Promise<Uint8Array<ArrayBufferLike>>
A promise resolving to a Uint8Array instance.
- Defined in index.d.ts:1806

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.
- Defined in index.d.ts:1814

isDescendantOf

isDescendantOf(ancestor: ZipDirectoryEntry): boolean
Tests if a ZipDirectoryEntry instance is an ancestor of the entry
Parameters
- ancestor: ZipDirectoryEntry
  The ZipDirectoryEntry instance.
Returns boolean
Inherited from ZipEntry.isDescendantOf
- Defined in index.d.ts:1727

isPasswordProtected

isPasswordProtected(): boolean
Tests if the entry or any of its children is password protected

Returns boolean
Inherited from ZipEntry.isPasswordProtected
- Defined in index.d.ts:1731

rename

rename(name: string): void
Set the name of the entry
Parameters
- name: string
  The new name of the entry.
Returns void
Inherited from ZipEntry.rename
- Defined in index.d.ts:1744

replaceBlob

replaceBlob(blob: Blob): void
Replaces the content of the entry with a Blob instance
Parameters
- blob: Blob
  The Blob instance.
Returns void
- Defined in index.d.ts:1845

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
- Defined in index.d.ts:1857

replaceReadable

replaceReadable(readable: ReadableStream): void
Replaces the content of the entry with a ReadableStream instance
Parameters
- readable: ReadableStream
  The ReadableStream instance.
Returns void
- Defined in index.d.ts:1869

replaceText

replaceText(text: string): void
Replaces the content of the entry with a string
Parameters
- text: string
  The string.
Returns void
- Defined in index.d.ts:1851

replaceUint8Array

replaceUint8Array(array: Uint8Array): void
Replaces the content of the entry with a Uint8Array instance
Parameters
- array: Uint8Array
  The Uint8Array instance.
Returns void
- Defined in index.d.ts:1863

Class ZipFileEntry<ReaderType, WriterType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns ZipFileEntry<ReaderType, WriterType>

Properties

children

Optionaldata

directory

id

name

Optionalparent

reader

uncompressedSize

writer

Methods

checkPassword

Parameters

Returns Promise<boolean>

clone

Parameters

Returns ZipEntry

getArrayBuffer

Parameters

Returns Promise<ArrayBuffer>

getBlob

Parameters

Returns Promise<Blob>

getData

Type Parameters

Parameters

Returns Promise<Type>

getData64URI

Parameters

Returns Promise<string>

getFullname

Returns string

getRelativeName

Parameters

Returns string

getText

Parameters

Returns Promise<string>

getUint8Array

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

getWritable

Parameters

Returns Promise<WritableStream<any>>

isDescendantOf

Parameters

Returns boolean

isPasswordProtected

Returns boolean

rename

Parameters

Returns void

replaceBlob

Parameters

Returns void

replaceData64URI

Parameters

Returns void

replaceReadable

Parameters

Returns void

replaceText

Parameters

Returns void

replaceUint8Array

Parameters

Returns void

Settings

On This Page

`Optional`data

`Optional`parent