Class FolderHandler

Readonly isFolder

addChildDirs

• addChildDirs(childNames, walletRef): Promise<{
      encoded: EncodeObject[];
      existing: string[];
  }>

• Add direct child Folder(s) to this Folder's metadata.

  Parameters

  • childNames: string[]

    Array of names to add as direct child Folders.

  • walletRef: IWalletHandler

    WalletHandler instance.

  Returns Promise<{
      encoded: EncodeObject[];
      existing: string[];
  }>

addChildFileReferences

• addChildFileReferences(newFiles, walletRef): Promise<EncodeObject>

• Add direct child file(s) to this Folder's metadata.

  Parameters

  • newFiles: IFileMetaHashMap

    Map of file metadata using file name as key.

  • walletRef: IWalletHandler

    WalletHandler instance.

  Returns Promise<EncodeObject>

getChildDirs

• getChildDirs(): string[]

• Get all direct child folders.

  Returns string[]

getChildFiles

• getChildFiles(): {
      [name: string]: IFileMeta;
  }

• Get all direct child files.

  Returns {
      [name: string]: IFileMeta;
  }

  • [name: string]: IFileMeta

getChildMerkle

• getChildMerkle(child): Promise<string>

• Get full merkle string of path to target child.

  Parameters

  • child: string

    Name of child Folder or file.

  Returns Promise<string>

getFolderDetails

• getFolderDetails(): IFolderFrame

• Get full Folder metadata.

  Returns IFolderFrame

getForFiletree

• getForFiletree(walletRef): Promise<EncodeObject>

• Creates and returns FileTree EncodeObject for saving Folder to network.

  Parameters

  • walletRef: IWalletHandler

    WalletHandler instance.

  Returns Promise<EncodeObject>

getMyChildPath

• getMyChildPath(child): string

• Get full path for target child.

  Parameters

  • child: string

  Returns string

getMyPath

• getMyPath(): string

• Get full Folder path (parent path + Folder name)

  Returns string

getWhereAmI

• getWhereAmI(): string

• Get parent path of Folder.

  Returns string

getWhoAmI

• getWhoAmI(): string

• Get name of Folder.

  Returns string

getWhoOwnsMe

• getWhoOwnsMe(): string

• Get Bech32 address of Folder owner.

  Returns string

makeChildDirInfo

• makeChildDirInfo(childName): IChildDirInfo

• Generate metadata bundle to create new direct child Folder. For use with FolderHandler.trackNewFolder().

  Parameters

  • childName: string

    Name of Folder to create.

  Returns IChildDirInfo

removeChildDirAndFileReferences

• removeChildDirAndFileReferences(dirs, files, walletRef): Promise<EncodeObject>

• Remove direct child Folder(s) and/or file(s) from this Folder's metadata.

  Parameters

  • dirs: string[]

    Array of names to remove as direct child Folders.

  • files: string[]

    Array of names to remove as direct child files.

  • walletRef: IWalletHandler

    WalletHandler instance.

  Returns Promise<EncodeObject>

removeChildDirReferences

• removeChildDirReferences(toRemove, walletRef): Promise<EncodeObject>

• Remove direct child Folder(s) from this Folder's metadata.

  Parameters

  • toRemove: string[]

    Array of names to remove as direct child Folders.

  • walletRef: IWalletHandler

    WalletHandler instance.

  Returns Promise<EncodeObject>

removeChildFileReferences

• removeChildFileReferences(toRemove, walletRef): Promise<EncodeObject>

• Remove direct child file(s) from this Folder's metadata.

  Parameters

  • toRemove: string[]

    Array of names to remove as direct child files.

  • walletRef: IWalletHandler

    WalletHandler instance.

  Returns Promise<EncodeObject>

Static trackFolder

• trackFolder(dirInfo): Promise<IFolderHandler>

• Async wrapper to create a FolderHandler instance from a FileTree source.

  Parameters

  • dirInfo: IFolderFrame

    Folder metadata.

  Returns Promise<IFolderHandler>

Static trackNewFolder

• trackNewFolder(dirInfo): Promise<IFolderHandler>

• Async wrapper to create a FolderHandler instance for a new folder.

  Parameters

  • dirInfo: IChildDirInfo

    Initial Folder details.

  Returns Promise<IFolderHandler>