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 @ e2d4f172
[@hiveio/beekeeper v1.27.6-rc2-stable.240829154113](../globals) / IBeekeeperSession [@hiveio/beekeeper v1.27.6-rc2-stable.240904055309](../globals) / IBeekeeperSession
# Interface: IBeekeeperSession # Interface: IBeekeeperSession
...@@ -22,17 +22,19 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -22,17 +22,19 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Source #### Source
[src/interfaces.ts:247](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/c7574b3fdbfab6796594a8da3b210d810085a4ca/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L247) [src/interfaces.ts:279](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L279)
*** ***
### createWallet() ### createWallet()
#### createWallet(name, password)
> **createWallet**(`name`, `password`?): `Promise`\<[`IWalletCreated`](./IWalletCreated)\> > **createWallet**(`name`, `password`?): `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
Creates a new Beekeeper wallet object owned by this session Creates a new Beekeeper wallet object owned by this session
#### Parameters ##### Parameters
• **name**: `string` • **name**: `string`
...@@ -42,19 +44,53 @@ name of wallet ...@@ -42,19 +44,53 @@ name of wallet
password used for creation of a wallet. Not required and in this case a password is automatically generated and returned password used for creation of a wallet. Not required and in this case a password is automatically generated and returned
#### Returns ##### Returns
`Promise`\<[`IWalletCreated`](./IWalletCreated)\> `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
the created unlocked Beekeeper wallet object the created unlocked Beekeeper wallet object
#### Throws ##### Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source ##### Source
[src/interfaces.ts:237](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L237)
#### createWallet(name, password, isTemporary)
> **createWallet**(`name`, `password`, `isTemporary`): `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
• **isTemporary**: `boolean`
If `true` the wallet exists only in memory otherwise is saved into a file. (defaults to `false`)
##### Returns
`Promise`\<[`IWalletCreated`](./IWalletCreated)\>
the created unlocked Beekeeper wallet object
[src/interfaces.ts:218](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/c7574b3fdbfab6796594a8da3b210d810085a4ca/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L218) ##### Throws
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/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L250)
*** ***
...@@ -76,7 +112,35 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -76,7 +112,35 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Source #### Source
[src/interfaces.ts:197](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/c7574b3fdbfab6796594a8da3b210d810085a4ca/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L197) [src/interfaces.ts:205](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L205)
***
### hasWallet()
> **hasWallet**(`name`): `boolean`
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.)
#### Source
[src/interfaces.ts:216](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L216)
*** ***
...@@ -98,7 +162,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -98,7 +162,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Source #### Source
[src/interfaces.ts:206](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/c7574b3fdbfab6796594a8da3b210d810085a4ca/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L206) [src/interfaces.ts:225](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L225)
*** ***
...@@ -120,7 +184,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -120,7 +184,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Source #### Source
[src/interfaces.ts:238](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/c7574b3fdbfab6796594a8da3b210d810085a4ca/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L238) [src/interfaces.ts:270](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L270)
*** ***
...@@ -148,4 +212,4 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -148,4 +212,4 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Source #### Source
[src/interfaces.ts:229](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/c7574b3fdbfab6796594a8da3b210d810085a4ca/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L229) [src/interfaces.ts:261](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/7c6186ff47963b8114d30f865049b0160466af92/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L261)