@tkey-singularity/chrome-storage
v7.2.0
Published
TKey Chrome Storage Module
Downloads
1
Readme
tKey Chrome Storage Module
The tKey Chrome Storage Module helps you store and recall key shares in the chrome extension storage. This module is the part of the tKey SDK.
Installation
npm install --save @tkey/chrome-storage
Initialization
Import the ChromeExtensionStorageModule
class from @tkey/chrome-storage
import ChromeExtensionStorageModule from "@tkey/chrome-storage";
Assign the ChromeExtensionStorageModule
class to a variable
const chromeStorageModule = new ChromeExtensionStorageModule();
Returns
The ChromeExtensionStorageModule
class returns an object with the following properties:
class ChromeExtensionStorageModule implements IModule {
moduleName: string;
tbSDK: ITKeyApi;
constructor();
setModuleReferences(tbSDK: ITKeyApi): void;
initialize(): Promise<void>;
storeDeviceShare(deviceShareStore: ShareStore, customDeviceInfo?: StringifiedType): Promise<void>;
storeShareOnChromeExtensionStorage(share: ShareStore): Promise<void>;
getStoreFromChromeExtensionStorage(): Promise<ShareStore>;
inputShareFromChromeExtensionStorage(): Promise<void>;
}
Usage
With the ChromeExtensionStorageModule
, you've access to the following functions:
Storing a Device Share
storeDeviceShare(deviceShareStore, customDeviceInfo?)
deviceShareStore
: TheShareStore
object to store.customDeviceInfo?
: Information about the device to store.
ShareStore
class ShareStore implements ISerializable {
share: Share;
polynomialID: PolynomialID;
constructor(share: Share, polynomialID: PolynomialID);
static fromJSON(value: StringifiedType): ShareStore;
toJSON(): StringifiedType;
}
interface ISerializable {
toJSON(): StringifiedType;
}
Storing a Share on Chrome Extension Storage
storeShareOnChromeExtensionStorage(share)
share
: TheShareStore
object to store.
Get a ShareStore from Chrome Extension Storage
getStoreFromChromeExtensionStorage()
Return
Promise<ShareStore>
: TheShareStore
object.