Class FileCollection

constructor

• new FileCollection(files: FileCollectionItem[]): FileCollection

• Parameters

  • files: FileCollectionItem[]

  Returns FileCollection

Readonlyfiles

[iterator]

• "[iterator]"(): ArrayIterator<FileCollectionItem>

• Returns ArrayIterator<FileCollectionItem>

addArrayBuffer

• addArrayBuffer(
      relativePath: string,
      arrayBuffer: ArrayBuffer,
      options?: { dateModified?: number },
  ): void

• Parameters

  • relativePath: string
  • arrayBuffer: ArrayBuffer
  • options: { dateModified?: number } = {}

  Returns void

addText

• addText(
      relativePath: string,
      text: string,
      options?: { dateModified?: number },
  ): void

• Parameters

  • relativePath: string
  • text: string
  • options: { dateModified?: number } = {}

  Returns void

addTypedArray

• addTypedArray(
      relativePath: string,
      typedArray: Uint8Array,
      options?: { dateModified?: number },
  ): void

• Parameters

  • relativePath: string
  • typedArray: Uint8Array
  • options: { dateModified?: number } = {}

  Returns void

filter

• filter(callback: (file: FileCollectionItem) => unknown): FileCollection

• Parameters

  • callback: (file: FileCollectionItem) => unknown

  Returns FileCollection

zip

• zip(): Promise<Uint8Array>

• Zip the FileCollection This method returns a new FileCollection that contains only one FileItem that is the zipped file (called by default 'file.zip') Not sure this is super useful and we should probably remove it and replace it by fileCollectionToZip

  Returns Promise<Uint8Array>