Changes

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