Changes

Page history
Update generated documentation authored by Mateusz Tyszczak's avatar Mateusz Tyszczak
Show whitespace changes
Inline Side-by-side
interfaces/IBeekeeperSession.md
View page @ 1f763367
[@hiveio/beekeeper v1.27.8-stable.250128093537](../globals) / IBeekeeperSession
[@hiveio/beekeeper](../globals) / IBeekeeperSession
# Interface: IBeekeeperSession
Defined in: [src/detailed/interfaces.ts:197](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L197)
## Methods
### close()
> **close**(): [`IBeekeeperInstance`](./IBeekeeperInstance)
Defined in: [src/detailed/interfaces.ts:279](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L279)
Locks all of the unlocked wallets, closes them, closes this session and makes it unusable
#### Returns
......@@ -20,27 +24,29 @@ Beekeeper instance owning the closed session
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:279](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L279)
***
### createWallet()
#### createWallet(name, password)
#### Call Signature
> **createWallet**(`name`, `password`?): `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
Defined in: [src/detailed/interfaces.ts:237](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L237)
Creates a new Beekeeper wallet object owned by this session
##### Parameters
• **name**: `string`
###### name
`string`
name of wallet
• **password?**: `string`
###### password?
`string`
password used for creation of a wallet. Not required and in this case a password is automatically generated and returned
......@@ -54,27 +60,31 @@ the created unlocked Beekeeper wallet object
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
##### Source
[src/interfaces.ts:237](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L237)
#### createWallet(name, password, isTemporary)
#### Call Signature
> **createWallet**(`name`, `password`, `isTemporary`): `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
Defined in: [src/detailed/interfaces.ts:250](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L250)
Creates a new Beekeeper wallet object owned by this session
##### Parameters
• **name**: `string`
###### name
`string`
name of wallet
• **password**: `string`
###### password
`string`
password used for creation of a wallet. Not required and in this case a password is automatically generated and returned
• **isTemporary**: `boolean`
###### isTemporary
`boolean`
If `true` the wallet exists only in memory otherwise is saved into a file. (defaults to `false`)
......@@ -88,16 +98,14 @@ the created unlocked Beekeeper wallet object
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
##### Source
[src/interfaces.ts:250](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L250)
***
### getInfo()
> **getInfo**(): [`IBeekeeperInfo`](./IBeekeeperInfo)
Defined in: [src/detailed/interfaces.ts:205](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L205)
Retrieves the current session info
#### Returns
......@@ -110,21 +118,21 @@ Current session information
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:205](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L205)
***
### hasWallet()
> **hasWallet**(`name`): `boolean`
Defined in: [src/detailed/interfaces.ts:216](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L216)
Checks if wallet with given name exists
#### Parameters
• **name**: `string`
##### name
`string`
name of the wallet
......@@ -138,16 +146,14 @@ name of the wallet
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:216](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L216)
***
### listWallets()
> **listWallets**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
Defined in: [src/detailed/interfaces.ts:225](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L225)
Lists all of the opened wallets
#### Returns
......@@ -160,16 +166,14 @@ array of opened Beekeeper wallets (either unlocked or locked)
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:225](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L225)
***
### lockAll()
> **lockAll**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
Defined in: [src/detailed/interfaces.ts:270](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L270)
Locks all of the unlocked wallets owned by this session
#### Returns
......@@ -182,21 +186,21 @@ array of the locked Beekeeper wallets
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:270](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L270)
***
### openWallet()
> **openWallet**(`name`): [`IBeekeeperWallet`](./IBeekeeperWallet)
Defined in: [src/detailed/interfaces.ts:261](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L261)
Opens Beekeeper wallet object owned by this session
#### Parameters
• **name**: `string`
##### name
`string`
name of wallet
......@@ -209,7 +213,3 @@ the opened Beekeeper wallet object (may be unlocked if it has been previously un
#### Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:261](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L261)