Class FileEntry<TBuffer>

Referred to as a "central directory" record in the spec. This is a file metadata entry inside the "central directory".

Type Parameters

  • TBuffer extends ArrayBufferLike = ArrayBuffer

Hierarchy

Indexable

  • [index: number]: number

Constructors

  • Type Parameters

    • TBuffer extends ArrayBufferLike = ArrayBuffer

    Parameters

    • buffer: TBuffer
    • OptionalbyteOffset: number
    • Optionallength: number

    Returns FileEntry<TBuffer>

Properties

"[toStringTag]": "Uint8Array"
buffer: TBuffer

The ArrayBuffer instance referenced by the array.

byteLength: number

The length in bytes of the array.

byteOffset: number

The offset in bytes of the array.

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

length: number

The length of the array.

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

Accessors

attributeCompat: any

The upper byte of "version made by", indicates the compatibility of the file attribute information.

commentLength: any

The length of the comment

compressedSize: any

The size of the file compressed

compressionMethod: any
crc32: any
  • get data(): Uint8Array
  • Returns Uint8Array

    Use contents

datetime: any
externalAttributes: any

The mapping of the external attributes is host-system dependent. For MS-DOS, the low order byte is the MS-DOS directory attribute byte. If input came from standard input, this field is set to zero.

extraLength: any

The length of the extra field

flag: any

General purpose bit flags

headerRelativeOffset: any

This is the offset from the start of the first disk on which this file appears to where the local header should be found.

internalAttributes: any
  • get isDirectory(): boolean
  • Whether this entry is a directory

    Returns boolean

  • get isFile(): boolean
  • Whether this entry is a file

    Returns boolean

  • get name(): string
  • The name of the file, with optional relative path. The filename is preloaded here, since looking it up is expensive.

    4.4.17.1 claims:

    • All slashes are forward ('/') slashes.
    • Filename doesn't begin with a slash.
    • No drive letters
    • If filename is missing, the input came from standard input.

    Unfortunately, this isn't true in practice. Some Windows zip utilities use a backslash here, but the correct Unix-style path in file headers. To avoid seeking all over the file to recover the known-good filenames from file headers, we simply convert '' to '/' here.

    Returns string

nameLength: any

The length of the file name

signature: any
  • get size(): number
  • The total size of the this entry

    Returns number

startDisk: any

The number of the disk on which this file begins.

uncompressedSize: any

The size of the file uncompressed

versionNeeded: any

The minimum supported ZIP specification version needed to extract the file.

zipVersion: any

The lower byte of "version made by", indicates the ZIP specification version supported by the software used to encode the file. major — floor zipVersion / 10 minor — zipVersion mod 10

Methods

  • Returns ArrayIterator<number>

  • Returns the item located at the specified index.

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

    Returns undefined | number

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optionalend: number

      If not specified, length of the this object is used as its default value.

    Returns this

  • Returns an array of key, value pairs for every entry in the array

    Returns ArrayIterator<[number, number]>

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

  • Changes all array elements from start to end index to a static value and returns the modified array

    Parameters

    • value: number

      value to fill array section with

    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: (value: number, index: number, array: this) => any

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns Uint8Array<ArrayBuffer>

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns undefined | number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: number, index: number, obj: this) => boolean

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

  • Returns the value of the last element in the array where predicate is true, and undefined otherwise.

    Type Parameters

    • S extends number

    Parameters

    • predicate: (value: number, index: number, array: this) => value is S

      findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.

    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns undefined | S

  • Parameters

    • predicate: (value: number, index: number, array: this) => unknown
    • OptionalthisArg: any

    Returns undefined | number

  • Returns the index of the last element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.

    • OptionalthisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (value: number, index: number, array: this) => void

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: number

      The element to search for.

    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: number

      The value to locate in the array.

    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optionalseparator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

  • Returns an list of keys in the array

    Returns ArrayIterator<number>

  • Returns the index of the last occurrence of a value in an array.

    Parameters

    • searchElement: number

      The value to locate in the array.

    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Parameters

    • callbackfn: (value: number, index: number, array: this) => number

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Uint8Array<ArrayBuffer>

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns number

  • Parameters

    • callbackfn: (
          previousValue: number,
          currentValue: number,
          currentIndex: number,
          array: this,
      ) => number
    • initialValue: number

    Returns number

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type Parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

  • Reverses the elements in an Array.

    Returns this

  • Sets a value or an array of values.

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

    • Optionaloffset: number

      The index in the current array at which the values are to be written.

    Returns void

  • Returns a section of an array.

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns Uint8Array<ArrayBuffer>

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: (value: number, index: number, array: this) => unknown

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

    • OptionalthisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

  • Sorts an array.

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

      [11,2,22,1].sort((a, b) => a - b)
      

    Returns this

  • Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

    • Optionalend: number

      The index of the end of the array.

    Returns Uint8Array<TBuffer>

  • Converts a number to a string by using the current locale.

    Returns string

  • Parameters

    • locales: string | string[]
    • Optionaloptions: NumberFormatOptions

    Returns string

  • Copies the array and returns the copy with the elements in reverse order.

    Returns Uint8Array<ArrayBuffer>

  • Copies and sorts the array.

    Parameters

    • OptionalcompareFn: (a: number, b: number) => number

      Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending order.

      const myNums = Uint8Array<Buffer>.from([11, 2, 22, 1]);
      myNums.toSorted((a, b) => a - b) // Uint8Array<Buffer>(4) [1, 2, 11, 22]

    Returns Uint8Array<ArrayBuffer>

  • Returns a string representation of an array.

    Returns string

  • Returns the primitive value of the specified object.

    Returns this

  • Returns an list of values in the array

    Returns ArrayIterator<number>

  • Copies the array and inserts the given number at the provided index.

    Parameters

    • index: number

      The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

    • value: number

      The value to insert into the copied array.

    Returns Uint8Array<ArrayBuffer>

    A copy of the original array with the inserted value.

  • Creates an array from an array-like or iterable object.

    Parameters

    • arrayLike: ArrayLike<number>

      An array-like or iterable object to convert to an array.

    Returns Uint8Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    Type Parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like or iterable object to convert to an array.

    • mapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns Uint8Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    Parameters

    • arrayLike: Iterable<number>

      An array-like or iterable object to convert to an array.

    Returns Uint8Array<ArrayBuffer>

  • Creates an array from an array-like or iterable object.

    Type Parameters

    • T

    Parameters

    • arrayLike: Iterable<T>

      An array-like or iterable object to convert to an array.

    • Optionalmapfn: (v: T, k: number) => number

      A mapping function to call on every element of the array.

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns Uint8Array<ArrayBuffer>

  • Returns a new array from a set of elements.

    Parameters

    • ...items: number[]

      A set of elements to include in the new array object.

    Returns Uint8Array<ArrayBuffer>