interfaces/IBeekeeperSession.md

+[@hiveio/beekeeper v1.27.6-rc1-stable.240626220315](../globals) / IBeekeeperSession
+
+# Interface: IBeekeeperSession
+
+## Methods
+
+### close()
+
+> **close**(): [`IBeekeeperInstance`](./IBeekeeperInstance)
+
+Locks all of the unlocked wallets, closes them, closes this session and makes it unusable
+
+#### Returns
+
+[`IBeekeeperInstance`](./IBeekeeperInstance)
+
+Beekeeper instance owning the closed session
+
+#### Throws
+
+on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
+
+#### Source
+
+[src/interfaces.ts:247](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L247)
+
+***
+
+### createWallet()
+
+> **createWallet**(`name`, `password`?): `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
+
+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`](./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.)
+
+#### Source
+
+[src/interfaces.ts:218](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L218)
+
+***
+
+### getInfo()
+
+> **getInfo**(): [`IBeekeeperInfo`](./IBeekeeperInfo)
+
+Retrieves the current session info
+
+#### Returns
+
+[`IBeekeeperInfo`](./IBeekeeperInfo)
+
+Current session information
+
+#### Throws
+
+on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
+
+#### Source
+
+[src/interfaces.ts:197](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L197)
+
+***
+
+### listWallets()
+
+> **listWallets**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
+
+Lists all of the opened wallets
+
+#### Returns
+
+[`IBeekeeperWallet`](./IBeekeeperWallet)[]
+
+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.)
+
+#### Source
+
+[src/interfaces.ts:206](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L206)
+
+***
+
+### lockAll()
+
+> **lockAll**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
+
+Locks all of the unlocked wallets owned by this session
+
+#### Returns
+
+[`IBeekeeperWallet`](./IBeekeeperWallet)[]
+
+array of the locked Beekeeper wallets
+
+#### Throws
+
+on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
+
+#### Source
+
+[src/interfaces.ts:238](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L238)
+
+***
+
+### openWallet()
+
+> **openWallet**(`name`): [`IBeekeeperWallet`](./IBeekeeperWallet)
+
+Opens Beekeeper wallet object owned by this session
+
+#### Parameters
+
+• **name**: `string`
+
+name of wallet
+
+#### Returns
+
+[`IBeekeeperWallet`](./IBeekeeperWallet)
+
+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.)
+
+#### Source
+
+[src/interfaces.ts:229](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/838166b567c1d62715351c14be1f8e327570995c/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L229)