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 @ f9adb2a4
......@@ -8,17 +8,19 @@
> **enableLogs**: `boolean`
Whether logs can be written. By default logs are enabled
Whether internal Beekeeper core logs can be written. By default verbose Beekeeper core logs are disabled.
Having this option disabled doesn't prevent you from seeing logs or catching detailed Beekeeper errors in your application.
#### Default
```ts
true
false
```
#### Defined in
[src/detailed/interfaces.ts:88](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L88)
[src/detailed/interfaces.ts:89](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L89)
***
......@@ -27,7 +29,10 @@ true
> **inMemory**: `boolean`
Disables filesystem support (persistent storage) per this beekeeper instance and runs in-memory only.
By default, filesystem support is enabled
By default, filesystem support is enabled.
This option can be useful in environments where filesystem access is not available
(e.g. browsers, sandbox environments or Node.js process ran by user without write permissions).
#### Default
......@@ -37,7 +42,7 @@ false
#### Defined in
[src/detailed/interfaces.ts:81](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L81)
[src/detailed/interfaces.ts:80](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L80)
***
......@@ -47,11 +52,11 @@ false
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 "./storage_root-node" for Node.js
#### Defined in
[src/detailed/interfaces.ts:62](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L62)
[src/detailed/interfaces.ts:58](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L58)
***
......@@ -71,7 +76,7 @@ Activity is defined as any wallet command e.g. list-wallets
#### Defined in
[src/detailed/interfaces.ts:98](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L98)
[src/detailed/interfaces.ts:99](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L99)
***
......@@ -82,8 +87,8 @@ Activity is defined as any wallet command e.g. list-wallets
The path to the WASM file. It can be a relative path or an absolute URL
If not specified, the default path is used: "./build/beekeeper_wasm.common.wasm" (may change if bundled)
Note: You can also specify a base64 encoded string of the WASM file to be used directly when inlining
This option also accepts an inlined base64 encoded string of the WASM file as a value (`data:application/wasm;base64,...`)
#### Defined in
[src/detailed/interfaces.ts:72](https://gitlab.syncad.com/hive/hive/-/blob/888c7b858da0da4ca12a003c97b1387d070d247a/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L72)
[src/detailed/interfaces.ts:68](https://gitlab.syncad.com/hive/hive/-/blob/5fee669ddea2816c2503b0e345584c760a71288d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L68)