Class FileIo

Hierarchy

FileIo

Implements

IFileIo

Constructors

`Private` constructor

new FileIo(wallet, providers, currentProvider): FileIo
Private
Receives properties from trackIo() to instantiate FileIo.
Parameters
- wallet: IWalletHandler
  
  WalletHandler instance for QueryHandler and ProtoHandler management.
- providers: IMiner[]
  
  Array of filtered Provider details to cycle through for uploads.
- currentProvider: IMiner
  
  Starting active upload Provider.
Returns FileIo
- Defined in src/classes/fileIo.ts:75

Properties

`Private` availableProviders

availableProviders: IMiner[]

`Private` currentProvider

currentProvider: IMiner

`Private` `Readonly` qH

qH: IQueryHandler

`Private` `Readonly` walletRef

walletRef: IWalletHandler

Methods

checkFolderIsFileTree

checkFolderIsFileTree(rawPath): Promise<null | IFolderHandler>
Determine if a Folder is File or FileTree based.
Parameters
- rawPath: string
  
  Full path to the target Folder.
Returns Promise<null | IFolderHandler>
- Returns FolderHandler instance if Folder is FileTree-based.
Implementation of IFileIo.checkFolderIsFileTree
- Defined in src/classes/fileIo.ts:812

clearProblems

clearProblems(exclude): Promise<void>
Remove problem Provider from list and select new active Provider.
Parameters
- exclude: string
  
  Provider address to exclude.
Returns Promise<void>
Implementation of IFileIo.clearProblems
- Defined in src/classes/fileIo.ts:158

convertFolderType

convertFolderType(rawPath): Promise<IFolderHandler>
Converts File-based Folders to FileTree-based Folders. Wraps rawConvertFolderType().
Parameters
- rawPath: string
  
  Full path to the target Folder.
Returns Promise<IFolderHandler>
Implementation of IFileIo.convertFolderType
- Defined in src/classes/fileIo.ts:765

`Private` createFileTreeFolderMsg

createFileTreeFolderMsg(pathName, parentPath, creator): Promise<EncodeObject>
Private
Generate FolderHandler for target new folder. Used by rawGenerateInitialDirs().
Parameters
- pathName: string
  
  Name of Folder.
- parentPath: string
  
  Full path to parent Folder.
- creator: string
  
  Bech32 address of owner.
Returns Promise<EncodeObject>
- Defined in src/classes/fileIo.ts:848

createFolders

createFolders(parentDir, newDirs): Promise<void>
Create new Subfolder(s) with single shared parent Folder. Wrapper for rawCreateFolders().
Parameters
- parentDir: IFolderHandler
  
  Parent Folder instance.
- newDirs: string[]
  
  Name(s) of Subfolder(s) to create.
Returns Promise<void>
Implementation of IFileIo.createFolders
- Defined in src/classes/fileIo.ts:239

`Private` createRoot

createRoot(): Promise<EncodeObject>
Private
Create s/.

Returns Promise<EncodeObject>
- Defined in src/classes/fileIo.ts:949

deleteTargets

deleteTargets(targets, parent): Promise<void>
Deletes target Folder(s) and sub folders/files. Wraps rawDeleteTargets().
Parameters
- targets: string[]
  
  Target Folder(s) and/or files and children.
- parent: IFolderHandler
  
  Parent Folder that is NOT being deleted.
Returns Promise<void>
Implementation of IFileIo.deleteTargets
- Defined in src/classes/fileIo.ts:631

downloadFile

downloadFile(downloadDetails, completion): Promise<IFileDownloadHandler>
Download File.
Parameters
- downloadDetails: IDownloadDetails
  
  Details needed to find file.
- completion: {
  track: number;
  }
  
  External access to download progress.
  - track: number
Returns Promise<IFileDownloadHandler>
Implementation of IFileIo.downloadFile
- Defined in src/classes/fileIo.ts:489

downloadFileByFid

downloadFileByFid(fid, completion): Promise<IFileDownloadHandler>
Locate and download file using unique FID.
Parameters
- fid: string
  
  FID for target File.
- completion: {
  track: number;
  }
  
  External access to download progress.
  - track: number
Returns Promise<IFileDownloadHandler>
Implementation of IFileIo.downloadFileByFid
- Defined in src/classes/fileIo.ts:575

downloadFolder

downloadFolder(rawPath): Promise<IFolderHandler>
Fetches FileTree data for target Folder and creates Handler instance.
Parameters
- rawPath: string
  
  Full path to Folder. Example: s/Node/Pictures.
Returns Promise<IFolderHandler>
Implementation of IFileIo.downloadFolder
- Defined in src/classes/fileIo.ts:459

forceProvider

forceProvider(toSet): void
Set active Provider for uploads.
Parameters
- toSet: IMiner
Returns void
Implementation of IFileIo.forceProvider
- Defined in src/classes/fileIo.ts:149

generateInitialDirs

generateInitialDirs(initMsg, startingDirs?): Promise<void>
Creates target base Folders and inits storage if provided. Wraps rawGenerateInitialDirs().
Parameters
- initMsg: null | EncodeObject
  
  Msg to init storage if needed.
- Optional startingDirs: string[]
  
  Base Folders to create. (Optional)
Returns Promise<void>
Implementation of IFileIo.generateInitialDirs
- Defined in src/classes/fileIo.ts:714

getAvailableProviders

getAvailableProviders(): IMiner[]
Expose all active Providers available for uploads.

Returns IMiner[]
Implementation of IFileIo.getAvailableProviders
- Defined in src/classes/fileIo.ts:141

getCurrentProvider

getCurrentProvider(): IMiner
Expose active Provider for uploads.

Returns IMiner
Implementation of IFileIo.getCurrentProvider
- Defined in src/classes/fileIo.ts:133

`Private` makeDelete

makeDelete(creator, targets): Promise<EncodeObject[]>
Private
Creates and returns FileTree and Storage EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- creator: string
  
  Bech32 address of owner.
- targets: string[]
  
  Full path to deletion target.
Returns Promise<EncodeObject[]>
- Defined in src/classes/fileIo.ts:871

migrate

migrate(toCheck): Promise<void>
Converts File-based folder(s) to FileTree-based folder(s).
Parameters
- toCheck: string[]
  
  Folder paths (without s/) to check and convert.
Returns Promise<void>
Implementation of IFileIo.migrate
- Defined in src/classes/fileIo.ts:194

`Private` rawAfterUpload

rawAfterUpload(ids): Promise<EncodeObject[]>
Private
Saves completed uploads to FileTree.
Parameters
- ids: IQueueItemPostUpload[]
  
  Bundle(s) of details on uploaded file(s).
Returns Promise<EncodeObject[]>
- Defined in src/classes/fileIo.ts:399

rawConvertFolderType

rawConvertFolderType(rawPath): Promise<EncodeObject[]>
Creates and returns FileTree and Storage EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- rawPath: string
  
  Full path to the target Folder.
Returns Promise<EncodeObject[]>
Implementation of IFileIo.rawConvertFolderType
- Defined in src/classes/fileIo.ts:784

rawCreateFolders

rawCreateFolders(parentDir, newDirs): Promise<EncodeObject[]>
Creates and returns FileTree EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- parentDir: IFolderHandler
  
  Parent Folder instance.
- newDirs: string[]
  
  Name(s) of Subfolder(s) to create.
Returns Promise<EncodeObject[]>
Implementation of IFileIo.rawCreateFolders
- Defined in src/classes/fileIo.ts:257

rawDeleteTargets

rawDeleteTargets(targets, parent): Promise<EncodeObject[]>
Creates and returns FileTree and Storage EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- targets: string[]
  
  Target Folder(s) and/or files and children.
- parent: IFolderHandler
  
  Parent Folder that is NOT being deleted.
Returns Promise<EncodeObject[]>
Implementation of IFileIo.rawDeleteTargets
- Defined in src/classes/fileIo.ts:658

rawGenerateInitialDirs

rawGenerateInitialDirs(initMsg, startingDirs?): Promise<EncodeObject[]>
Creates and returns FileTree EncodeObject instances for external consumption by a signAndBroadcast.
Parameters
- initMsg: null | EncodeObject
  
  Msg to init storage if needed.
- Optional startingDirs: string[]
  
  Base Folders to create. (Optional)
Returns Promise<EncodeObject[]>
Implementation of IFileIo.rawGenerateInitialDirs
- Defined in src/classes/fileIo.ts:739

refresh

refresh(): Promise<void>
Re-queries network for Providers and randomly selects new active Provider.

Returns Promise<void>
Implementation of IFileIo.refresh
- Defined in src/classes/fileIo.ts:178

shuffle

shuffle(): Promise<void>
Randomly selects new active Provider from list of active Providers available for uploads.

Returns Promise<void>
Implementation of IFileIo.shuffle
- Defined in src/classes/fileIo.ts:169

staggeredUploadFiles

staggeredUploadFiles(sourceHashMap, parent, tracker): Promise<void>
Uploads file(s) and queues successes into batches for wallet prompts.
Parameters
- sourceHashMap: IUploadList
  
  Map of all files, key is file name.
- parent: IFolderHandler
  
  Folder the files are being uploaded to.
- tracker: IStaggeredTracker
  
  External access to completion progress. Not yet implemented.
Returns Promise<void>
Implementation of IFileIo.staggeredUploadFiles
- Defined in src/classes/fileIo.ts:313

`Private` tumbleUpload

tumbleUpload(sender, file): Promise<IProviderModifiedResponse>
Private
Upload Files via Fetch and gracefully rollover to next provider if upload fails.
Parameters
- sender: string
  
  Bech32 address of owner.
- file: File
  
  File to upload.
Returns Promise<IProviderModifiedResponse>
- Defined in src/classes/fileIo.ts:922

verifyFoldersExist

verifyFoldersExist(toCheck): Promise<number>
Check if base Folders exist and create if not found.
Parameters
- toCheck: string[]
  
  Name(s) of base Folder(s) to check.
Returns Promise<number>
Implementation of IFileIo.verifyFoldersExist
- Defined in src/classes/fileIo.ts:278

`Static` checkProviders

checkProviders(wallet, versionFilter?): Promise<IProviderChecks>
Fetches and categorizes all providers registered to network.
Parameters
- wallet: IWalletHandler
  
  WalletHandler instance.
- Optional versionFilter: string | string[]
  
  Optional minimum chain version flag. Blocks all Providers if undefined. (Optional)
Returns Promise<IProviderChecks>
- Defined in src/classes/fileIo.ts:112

`Static` trackIo

trackIo(wallet, versionFilter?): Promise<FileIo>
Creates FileIo instance.
Parameters
- wallet: IWalletHandler
  
  WalletHandler instance.
- Optional versionFilter: string | string[]
  
  Optional minimum chain version flag. Blocks all Providers if undefined. (Optional)
Returns Promise<FileIo>
- Defined in src/classes/fileIo.ts:92

Class FileIo

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

wallet: IWalletHandler

providers: IMiner[]

currentProvider: IMiner

Returns FileIo

Properties

Private availableProviders

Private currentProvider

Private Readonly qH

Private Readonly walletRef

Methods

checkFolderIsFileTree

Parameters

rawPath: string

Returns Promise<null | IFolderHandler>

clearProblems

Parameters

exclude: string

Returns Promise<void>

convertFolderType

Parameters

rawPath: string

Returns Promise<IFolderHandler>

Private createFileTreeFolderMsg

Parameters

pathName: string

parentPath: string

creator: string

Returns Promise<EncodeObject>

createFolders

Parameters

parentDir: IFolderHandler

newDirs: string[]

Returns Promise<void>

Private createRoot

Returns Promise<EncodeObject>

deleteTargets

Parameters

targets: string[]

parent: IFolderHandler

Returns Promise<void>

downloadFile

Parameters

downloadDetails: IDownloadDetails

completion: { track: number; }

track: number

Returns Promise<IFileDownloadHandler>

downloadFileByFid

Parameters

fid: string

completion: { track: number; }

track: number

Returns Promise<IFileDownloadHandler>

downloadFolder

Parameters

rawPath: string

Returns Promise<IFolderHandler>

forceProvider

Parameters

toSet: IMiner

Returns void

generateInitialDirs

Parameters

initMsg: null | EncodeObject

Optional startingDirs: string[]

Returns Promise<void>

getAvailableProviders

Returns IMiner[]

getCurrentProvider

Returns IMiner

Private makeDelete

`Private` constructor

`Private` availableProviders

`Private` currentProvider

`Private` `Readonly` qH

`Private` `Readonly` walletRef

`Private` createFileTreeFolderMsg

`Private` createRoot

completion: {
track: number;
}

completion: {
track: number;
}

`Optional` startingDirs: string[]

`Private` makeDelete

`Private` rawAfterUpload

`Optional` startingDirs: string[]

`Private` tumbleUpload

`Static` checkProviders

`Optional` versionFilter: string | string[]

`Static` trackIo

`Optional` versionFilter: string | string[]