Changes

Page history
Update generated documentation authored by Mateusz Tyszczak's avatar Mateusz Tyszczak
Show whitespace changes
Inline Side-by-side
interfaces/IBeekeeperOptions.md
View page @ 1f763367
[@hiveio/beekeeper v1.27.8-stable.250128093537](../globals) / IBeekeeperOptions [@hiveio/beekeeper](../globals) / IBeekeeperOptions
# Interface: IBeekeeperOptions # Interface: IBeekeeperOptions
Defined in: [src/detailed/interfaces.ts:54](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L54)
## Properties ## Properties
### enableLogs ### enableLogs
> **enableLogs**: `boolean` > **enableLogs**: `boolean`
Defined in: [src/detailed/interfaces.ts:69](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L69)
Whether logs can be written. By default logs are enabled Whether logs can be written. By default logs are enabled
#### Default #### Default
...@@ -16,30 +20,26 @@ Whether logs can be written. By default logs are enabled ...@@ -16,30 +20,26 @@ Whether logs can be written. By default logs are enabled
true true
``` ```
#### Source
[src/interfaces.ts:69](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L69)
*** ***
### storageRoot ### storageRoot
> **storageRoot**: `string` > **storageRoot**: `string`
Defined in: [src/detailed/interfaces.ts:62](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L62)
The path of the wallet files (absolute path or relative to application data dir). Parent of the `.beekeeper` directory The path of the wallet files (absolute path or relative to application data dir). Parent of the `.beekeeper` directory
Defaults to "/storage_root" for web and "." for web Defaults to "/storage_root" for web and "." for web
#### Source
[src/interfaces.ts:62](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L62)
*** ***
### unlockTimeout ### unlockTimeout
> **unlockTimeout**: `number` > **unlockTimeout**: `number`
Defined in: [src/detailed/interfaces.ts:79](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L79)
Timeout for unlocked wallet in seconds (default 900 - 15 minutes). Timeout for unlocked wallet in seconds (default 900 - 15 minutes).
Wallets will automatically lock after specified number of seconds of inactivity. Wallets will automatically lock after specified number of seconds of inactivity.
Activity is defined as any wallet command e.g. list-wallets Activity is defined as any wallet command e.g. list-wallets
...@@ -49,7 +49,3 @@ Activity is defined as any wallet command e.g. list-wallets ...@@ -49,7 +49,3 @@ Activity is defined as any wallet command e.g. list-wallets
```ts ```ts
900 900
``` ```
#### Source
[src/interfaces.ts:79](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L79)