Class BrowserIframeStorage

Description

Class representing browser iframe storage

Hierarchy

AbstractStorage
- BrowserIframeStorage

Index

Constructors

Properties

iframe iframeOrigin iframeReadyPromiseResolve iframeUrl reqs timeout

Methods

clear delete getKeys handleMessage init op readBytes readJSON readString sendMessage storeBytes storeJSON storeString

Constructors

constructor

new BrowserIframeStorage(iframeUrl?: string, timeout?: number): BrowserIframeStorage
Parameters
- iframeUrl: string = 'https://ks.ylide.io/'
- timeout: number = 5000
Returns BrowserIframeStorage
Overrides AbstractStorage.constructor
- Defined in src/storage/BrowserIframeStorage.ts:14

Properties

`Private` iframe

iframe: null | HTMLIFrameElement = null

`Private` `Readonly` iframeOrigin

iframeOrigin: string

`Private` iframeReadyPromiseResolve

iframeReadyPromiseResolve: null | ((result: boolean) => void) = null

`Private` `Readonly` iframeUrl

iframeUrl: string = 'https://ks.ylide.io/'

`Private` `Readonly` reqs

reqs: Record<string, ((result?: any) => void)> = {}

`Private` `Readonly` timeout

timeout: number = 5000

Methods

clear

clear(): Promise<boolean>
Method to clear all key-value storage

Returns
Boolean indicating whether operation was successful

Returns Promise<boolean>
Overrides AbstractStorage.clear
- Defined in src/storage/BrowserIframeStorage.ts:97

delete

delete(key: string): Promise<boolean>
Method to get all keys from storage

Returns
Strings array with all the keys
Parameters
- key: string
Returns Promise<boolean>
Overrides AbstractStorage.delete
- Defined in src/storage/BrowserIframeStorage.ts:105

getKeys

getKeys(): Promise<string[]>
Method to get all keys from storage

Returns
Strings array with all the keys

Returns Promise<string[]>
Overrides AbstractStorage.getKeys
- Defined in src/storage/BrowserIframeStorage.ts:101

`Private` handleMessage

handleMessage(msg: {
data: any;
type: string;
}): void
Parameters
- msg: {
  data: any;
  type: string;
  }
  - data: any
  - type: string
Returns void
- Defined in src/storage/BrowserIframeStorage.ts:42

init

init(): Promise<boolean>
Method to initialize storage and check its availability

Returns Promise<boolean>
Overrides AbstractStorage.init
- Defined in src/storage/BrowserIframeStorage.ts:61

`Private` op

op<T>(type: string, data: any, objectToTransfer?: null | Transferable): Promise<T>
Type Parameters
- T = any
Parameters
- type: string
- data: any
- Optional objectToTransfer: null | Transferable
Returns Promise<T>
- Defined in src/storage/BrowserIframeStorage.ts:19

readBytes

readBytes(key: string): Promise<null | Uint8Array>
Method to read arbitrary bytes by key
Parameters
- key: string
  
  Key to retrieve
Returns Promise<null | Uint8Array>
Overrides AbstractStorage.readBytes
- Defined in src/storage/BrowserIframeStorage.ts:93

readJSON

readJSON<T>(key: string): Promise<null | T>
Method to read object by key
Type Parameters
- T
Parameters
- key: string
  
  Key to retrieve
Returns Promise<null | T>
Inherited from AbstractStorage.readJSON
- Defined in src/storage/AbstractStorage.ts:86

readString

readString(key: string): Promise<null | string>
Method to read string by key
Parameters
- key: string
  
  Key to retrieve
Returns Promise<null | string>
Inherited from AbstractStorage.readString
- Defined in src/storage/AbstractStorage.ts:73

`Private` sendMessage

sendMessage(type: string, data?: any, objectToTransfer?: null | Transferable): void
Parameters
- type: string
- Optional data: any
- Optional objectToTransfer: null | Transferable
Returns void
- Defined in src/storage/BrowserIframeStorage.ts:27

storeBytes

storeBytes(key: string, bytes: Uint8Array): Promise<boolean>
Method to store arbitrary bytes array
Parameters
- key: string
  
  Key for indexation
- bytes: Uint8Array
Returns Promise<boolean>
Overrides AbstractStorage.storeBytes
- Defined in src/storage/BrowserIframeStorage.ts:89

storeJSON

storeJSON(key: string, val: any): Promise<boolean>
Method to store arbitrary serializeable object
Parameters
- key: string
  
  Key for indexation
- val: any
Returns Promise<boolean>
Inherited from AbstractStorage.storeJSON
- Defined in src/storage/AbstractStorage.ts:36

storeString

storeString(key: string, str: string): Promise<boolean>
Method to store arbitrary string
Parameters
- key: string
  
  Key for indexation
- str: string
  
  Value to store
Returns Promise<boolean>
Inherited from AbstractStorage.storeString
- Defined in src/storage/AbstractStorage.ts:26

Generated using TypeDoc