reference

Class: GftpStorageProvider

storage/gftp.GftpStorageProvider

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new GftpStorageProvider(logger?)

Parameters

NameType
logger?Logger

Defined in

src/storage/gftp.ts:20

Methods

init

init(): Promise<void>

Initialize storage provider.

Returns

Promise<void>

Implementation of

StorageProvider.init

Defined in

src/storage/gftp.ts:26


isInitiated

isInitiated(): boolean

Returns

boolean

Defined in

src/storage/gftp.ts:61


receiveFile

receiveFile(path): Promise<string>

Return allocated resource URL from Yagna of a file to be downloaded.

Parameters

NameType
pathstring

Returns

Promise<string>

Implementation of

StorageProvider.receiveFile

Defined in

src/storage/gftp.ts:77


receiveData

receiveData(callback): Promise<string>

Return allocated resource URL from Yagna of a file to be downloaded.

Parameters

NameType
callbackStorageProviderDataCallback

Returns

Promise<string>

Implementation of

StorageProvider.receiveData

Defined in

src/storage/gftp.ts:83


publishFile

publishFile(src): Promise<string>

Return allocated resource URL from Yagna of a file to be uploaded.

Parameters

NameType
srcstring

Returns

Promise<string>

Implementation of

StorageProvider.publishFile

Defined in

src/storage/gftp.ts:87


publishData

publishData(src): Promise<string>

Return allocated resource URL from Yagna of data to be uploaded.

Parameters

NameType
srcUint8Array

Returns

Promise<string>

Implementation of

StorageProvider.publishData

Defined in

src/storage/gftp.ts:93


release

release(urls): Promise<void>

Release previously allocated resource URL from Yagna.

Parameters

NameType
urlsstring[]

Returns

Promise<void>

Implementation of

StorageProvider.release

Defined in

src/storage/gftp.ts:106


close

close(): Promise<void>

Close storage provider and release all resources.

Returns

Promise<void>

Implementation of

StorageProvider.close

Defined in

src/storage/gftp.ts:120


readStream

readStream(readable): AsyncGenerator<string, void, unknown>

Parameters

NameType
readableany

Returns

AsyncGenerator<string, void, unknown>

Defined in

src/storage/gftp.ts:147