Function useCollections

Returns { addCollection: ((name: string, files?: fsaCollectionFile[], description?: string, creator?: string, tags?: string[]) => Promise<boolean>); addFileToCollection: ((file: fsaFile, collection?: fsaCollection) => Promise<void>); cloneCollection: ((collection: fsaCollection, name?: string) => Promise<false | fsaCollection>); collections: fsaCollection[]; currentCollectionItems: fsaFile[]; fileIsInCurrentCollection: ((id: string) => boolean); removeAllFilesFromCollection: ((collectionId: string) => Promise<void>); removeCollection: ((collection: fsaCollection) => Promise<void>); removeFileFromCollection: ((file: fsaFile, collection?: fsaCollection) => Promise<void>); saveCollectionToFileSystem: ((collectionId: string) => Promise<undefined | false>); updateCollection: ((collection: fsaCollection) => Promise<boolean>) }

• addCollection: ((name: string, files?: fsaCollectionFile[], description?: string, creator?: string, tags?: string[]) => Promise<boolean>)

  • • (name: string, files?: fsaCollectionFile[], description?: string, creator?: string, tags?: string[]): Promise<boolean>

    • Parameters

      • name: string

      • files: fsaCollectionFile[] = []

      • description: string = ''

      • creator: string = ''

      • tags: string[] = []

      Returns Promise<boolean>

• addFileToCollection: ((file: fsaFile, collection?: fsaCollection) => Promise<void>)

  • • (file: fsaFile, collection?: fsaCollection): Promise<void>

    • Add a fsaFile to the current selected collection, if a collection is passed in then that collection receives the file

      Parameters

      • file: fsaFile

      • Optional collection: fsaCollection

      Returns Promise<void>

• cloneCollection: ((collection: fsaCollection, name?: string) => Promise<false | fsaCollection>)

  • • (collection: fsaCollection, name?: string): Promise<false | fsaCollection>

    • Parameters

      • collection: fsaCollection

      • name: string = 'copy'

      Returns Promise<false | fsaCollection>

• collections: fsaCollection[]

• currentCollectionItems: fsaFile[]

• fileIsInCurrentCollection: ((id: string) => boolean)

  • • (id: string): boolean

    • Parameters

      • id: string

      Returns boolean

• removeAllFilesFromCollection: ((collectionId: string) => Promise<void>)

  • • (collectionId: string): Promise<void>

    • Parameters

      • collectionId: string

      Returns Promise<void>

• removeCollection: ((collection: fsaCollection) => Promise<void>)

  • • (collection: fsaCollection): Promise<void>

    • Parameters

      • collection: fsaCollection

      Returns Promise<void>

• removeFileFromCollection: ((file: fsaFile, collection?: fsaCollection) => Promise<void>)

  • • (file: fsaFile, collection?: fsaCollection): Promise<void>

    • Removes a fsaFile from the current selected collection, if a collection is passed in then that collection has the file removed.

      Parameters

      • file: fsaFile

      • Optional collection: fsaCollection

      Returns Promise<void>

• saveCollectionToFileSystem: ((collectionId: string) => Promise<undefined | false>)

  • • (collectionId: string): Promise<undefined | false>

    • Parameters

      • collectionId: string

      Returns Promise<undefined | false>

• updateCollection: ((collection: fsaCollection) => Promise<boolean>)

  • • (collection: fsaCollection): Promise<boolean>

    • Just updates data, Do not change the files with this function, it will not add/remove them for you, use the removeFileFromCollection() addFileToCollection() instead.

      Parameters

      • collection: fsaCollection

      Returns Promise<boolean>