@hiveio/beekeeper / IBeekeeperSession
Interface: IBeekeeperSession
Defined in: src/detailed/interfaces.ts:197
Methods
close()
close():
IBeekeeperInstance
Defined in: src/detailed/interfaces.ts:279
Locks all of the unlocked wallets, closes them, closes this session and makes it unusable
Returns
Beekeeper instance owning the closed session
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
createWallet()
Call Signature
createWallet(
name,password?):Promise<IWalletCreated>
Defined in: src/detailed/interfaces.ts:237
Creates a new Beekeeper wallet object owned by this session
Parameters
name
string
name of wallet
password?
string
password used for creation of a wallet. Not required and in this case a password is automatically generated and returned
Returns
Promise<IWalletCreated>
the created unlocked Beekeeper wallet object
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
Call Signature
createWallet(
name,password,isTemporary):Promise<IWalletCreated>
Defined in: src/detailed/interfaces.ts:250
Creates a new Beekeeper wallet object owned by this session
Parameters
name
string
name of wallet
password
string
password used for creation of a wallet. Not required and in this case a password is automatically generated and returned
isTemporary
boolean
If true the wallet exists only in memory otherwise is saved into a file. (defaults to false)
Returns
Promise<IWalletCreated>
the created unlocked Beekeeper wallet object
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
getInfo()
getInfo():
IBeekeeperInfo
Defined in: src/detailed/interfaces.ts:205
Retrieves the current session info
Returns
Current session information
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
hasWallet()
hasWallet(
name):boolean
Defined in: src/detailed/interfaces.ts:216
Checks if wallet with given name exists
Parameters
name
string
name of the wallet
Returns
boolean
true if a wallet exists otherwise false
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
listWallets()
listWallets():
IBeekeeperWallet[]
Defined in: src/detailed/interfaces.ts:225
Lists all of the opened wallets
Returns
array of opened Beekeeper wallets (either unlocked or locked)
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
lockAll()
lockAll():
IBeekeeperWallet[]
Defined in: src/detailed/interfaces.ts:270
Locks all of the unlocked wallets owned by this session
Returns
array of the locked Beekeeper wallets
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
openWallet()
openWallet(
name):IBeekeeperWallet
Defined in: src/detailed/interfaces.ts:261
Opens Beekeeper wallet object owned by this session
Parameters
name
string
name of wallet
Returns
the opened Beekeeper wallet object (may be unlocked if it has been previously unlocked)
Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)