Class FileCollection

constructor

• new FileCollection(files): FileCollection

• Parameters

  • files: FileCollectionItem[]

  Returns FileCollection

Readonly files

[iterator]

• [iterator](): IterableIterator<FileCollectionItem>

• Returns IterableIterator<FileCollectionItem>

addArrayBuffer

• addArrayBuffer(relativePath, arrayBuffer, options?): void

• Parameters

  • relativePath: string

  • arrayBuffer: ArrayBuffer

  • options: {
        dateModified?: number;
    } = {}

    • Optional dateModified?: number

  Returns void

addText

• addText(relativePath, text, options?): void

• Parameters

  • relativePath: string

  • text: string

  • options: {
        dateModified?: number;
    } = {}

    • Optional dateModified?: number

  Returns void

addTypedArray

• addTypedArray(relativePath, typedArray, options?): void

• Parameters

  • relativePath: string

  • typedArray: Uint8Array

  • options: {
        dateModified?: number;
    } = {}

    • Optional dateModified?: number

  Returns void

filter

• filter(callback): FileCollection

• Parameters

  • callback: ((file) => unknown)

    • • (file): unknown

      • Parameters

        • file: FileCollectionItem

        Returns 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>