Class: WebSocketBrowserStorageProvider
shared/storage/ws-browser.WebSocketBrowserStorageProvider
Storage provider that uses GFTP over WebSockets.
Implements
Table of contents
Constructors
Methods
Constructors
constructor
• new WebSocketBrowserStorageProvider(yagnaApi, options): WebSocketBrowserStorageProvider
Parameters
| Name | Type |
|---|---|
yagnaApi | YagnaApi |
options | WebSocketStorageProviderOptions |
Returns
WebSocketBrowserStorageProvider
Defined in
src/shared/storage/ws-browser.ts:64
Methods
close
▸ close(): Promise<void>
Close storage provider and release all resources.
Returns
Promise<void>
Implementation of
Defined in
src/shared/storage/ws-browser.ts:71
init
▸ init(): Promise<void>
Initialize storage provider.
Returns
Promise<void>
Implementation of
Defined in
src/shared/storage/ws-browser.ts:76
publishData
▸ publishData(data): Promise<string>
Return allocated resource URL from Yagna of data to be uploaded.
Parameters
| Name | Type |
|---|---|
data | Uint8Array |
Returns
Promise<string>
Implementation of
Defined in
src/shared/storage/ws-browser.ts:81
publishFile
▸ publishFile(): Promise<string>
Return allocated resource URL from Yagna of a file to be uploaded.
Returns
Promise<string>
Implementation of
Defined in
src/shared/storage/ws-browser.ts:106
receiveData
▸ receiveData(callback): Promise<string>
Return allocated resource URL from Yagna of a file to be downloaded.
Parameters
| Name | Type |
|---|---|
callback | StorageProviderDataCallback |
Returns
Promise<string>
Implementation of
Defined in
src/shared/storage/ws-browser.ts:110
receiveFile
▸ receiveFile(): Promise<string>
Return allocated resource URL from Yagna of a file to be downloaded.
Returns
Promise<string>
Implementation of
Defined in
src/shared/storage/ws-browser.ts:136
release
▸ release(urls): Promise<void>
Release previously allocated resource URL from Yagna.
Parameters
| Name | Type |
|---|---|
urls | string[] |
Returns
Promise<void>
Implementation of
Defined in
src/shared/storage/ws-browser.ts:140
isReady
▸ isReady(): boolean
Tells if the storage provider is ready for use
Returns
boolean