Changes

Page history
Update generated documentation authored by Mateusz Tyszczak's avatar Mateusz Tyszczak
Show whitespace changes
Inline Side-by-side
interfaces/IBeekeeperWallet.md
View page @ a45ef824
......@@ -2,6 +2,8 @@
# Interface: IBeekeeperWallet
Defined in: [src/detailed/interfaces.ts:160](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L160)
## Extends
- [`IWallet`](./IWallet)
......@@ -12,43 +14,37 @@
> `readonly` **isTemporary**: `boolean`
Defined in: [src/detailed/interfaces.ts:31](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L31)
Indicates if wallet exists only in memory or is saved into a file.
#### Inherited from
[`IWallet`](./IWallet).[`isTemporary`](./IWallet#istemporary)
#### Defined in
[src/detailed/interfaces.ts:31](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L31)
***
### name
> `readonly` **name**: `string`
Defined in: [src/detailed/interfaces.ts:23](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L23)
Name of this wallet
#### Inherited from
[`IWallet`](./IWallet).[`name`](./IWallet#name)
#### Defined in
[src/detailed/interfaces.ts:23](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L23)
***
### unlocked?
> `readonly` `optional` **unlocked**: [`IBeekeeperUnlockedWallet`](./IBeekeeperUnlockedWallet)
Indicates if the wallet is unlocked. If the wallet is locked, this property will be undefined. IBeekeeperUnlockedWallet type otherwise
#### Defined in
Defined in: [src/detailed/interfaces.ts:178](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L178)
[src/detailed/interfaces.ts:178](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L178)
Indicates if the wallet is unlocked. If the wallet is locked, this property will be undefined. IBeekeeperUnlockedWallet type otherwise
## Methods
......@@ -56,6 +52,8 @@ Indicates if the wallet is unlocked. If the wallet is locked, this property will
> **close**(): [`IBeekeeperSession`](./IBeekeeperSession)
Defined in: [src/detailed/interfaces.ts:15](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L15)
Ensures that this wallet is locked, then closes it
#### Returns
......@@ -72,16 +70,14 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
[`IWallet`](./IWallet).[`close`](./IWallet#close)
#### Defined in
[src/detailed/interfaces.ts:15](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L15)
***
### unlock()
> **unlock**(`password`): [`IBeekeeperUnlockedWallet`](./IBeekeeperUnlockedWallet)
Defined in: [src/detailed/interfaces.ts:170](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L170)
Unlocks this wallet
#### Parameters
......@@ -101,7 +97,3 @@ Unlocked Beekeeper wallet
#### Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:170](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L170)