Changes

Page history
Update generated documentation authored by Andrzej Such's avatar Andrzej Such
Show whitespace changes
Inline Side-by-side
interfaces/IBeekeeperOptions.md
View page @ 991eb495
......@@ -2,16 +2,12 @@
# Interface: IBeekeeperOptions
Defined in: [src/detailed/interfaces.ts:54](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L54)
## Properties
### enableLogs
> **enableLogs**: `boolean`
Defined in: [src/detailed/interfaces.ts:69](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L69)
Whether logs can be written. By default logs are enabled
#### Default
......@@ -20,26 +16,30 @@ Whether logs can be written. By default logs are enabled
true
```
#### Defined in
[src/detailed/interfaces.ts:69](https://gitlab.syncad.com/hive/hive/-/blob/5129c6fa3704730f4e46fef950ab10f486f6561f/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L69)
***
### storageRoot
> **storageRoot**: `string`
Defined in: [src/detailed/interfaces.ts:62](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/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
Defaults to "/storage_root" for web and "." for web
#### Defined in
[src/detailed/interfaces.ts:62](https://gitlab.syncad.com/hive/hive/-/blob/5129c6fa3704730f4e46fef950ab10f486f6561f/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L62)
***
### unlockTimeout
> **unlockTimeout**: `number`
Defined in: [src/detailed/interfaces.ts:79](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L79)
Timeout for unlocked wallet in seconds (default 900 - 15 minutes).
Wallets will automatically lock after specified number of seconds of inactivity.
Activity is defined as any wallet command e.g. list-wallets
......@@ -49,3 +49,7 @@ Activity is defined as any wallet command e.g. list-wallets
```ts
900
```
#### Defined in
[src/detailed/interfaces.ts:79](https://gitlab.syncad.com/hive/hive/-/blob/5129c6fa3704730f4e46fef950ab10f486f6561f/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L79)