Changes

Page history
Update generated documentation authored by Mateusz Tyszczak's avatar Mateusz Tyszczak
Show whitespace changes
Inline Side-by-side
interfaces/IBeekeeperInstance.md
View page @ 1e525caf
......@@ -2,7 +2,25 @@
# Interface: IBeekeeperInstance
Defined in: [src/detailed/interfaces.ts:282](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/cb8b515260281948a555fa1f9122c8e29025bacc/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L282)
Defined in: [src/detailed/interfaces.ts:282](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/dc3c841cbae80a5a72f99349350ca5aedefe9944/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L282)
## Accessors
### version
#### Get Signature
> **get** **version**(): `string`
Defined in: [src/detailed/interfaces.ts:299](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/dc3c841cbae80a5a72f99349350ca5aedefe9944/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L299)
Retrieves the app build version of the Beekeeper API in SemVer format
##### Returns
`string`
the version of the Beekeeper API
## Methods
......@@ -10,7 +28,7 @@ Defined in: [src/detailed/interfaces.ts:282](https://gitlab.syncad.com/hive/hive
> **createSession**(`salt`): [`IBeekeeperSession`](./IBeekeeperSession)
Defined in: [src/detailed/interfaces.ts:292](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/cb8b515260281948a555fa1f9122c8e29025bacc/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L292)
Defined in: [src/detailed/interfaces.ts:292](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/dc3c841cbae80a5a72f99349350ca5aedefe9944/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L292)
Creation of a session
......@@ -38,7 +56,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
> **delete**(): `Promise`\<`void`\>
Defined in: [src/detailed/interfaces.ts:299](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/cb8b515260281948a555fa1f9122c8e29025bacc/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L299)
Defined in: [src/detailed/interfaces.ts:306](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/dc3c841cbae80a5a72f99349350ca5aedefe9944/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L306)
Locks all of the unlocked wallets, closes them, closes opened sessions and deletes the current Beekeeper API instance making it unusable
......
......