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 @ 1f763367
[@hiveio/beekeeper v1.27.8-stable.250128093537](../globals) / IBeekeeperInstance
[@hiveio/beekeeper](../globals) / IBeekeeperInstance
# Interface: IBeekeeperInstance
Defined in: [src/detailed/interfaces.ts:282](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L282)
## Methods
### createSession()
> **createSession**(`salt`): [`IBeekeeperSession`](./IBeekeeperSession)
Defined in: [src/detailed/interfaces.ts:292](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L292)
Creation of a session
#### Parameters
• **salt**: `string`
##### salt
`string`
a salt used for creation of a token
......@@ -26,16 +32,14 @@ a beekeeper session created explicitly. It can be used for further work for exam
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:292](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L292)
***
### delete()
> **delete**(): `Promise`\<`void`\>
Defined in: [src/detailed/interfaces.ts:299](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/4e34081251adff620657ddc1a65cfe9aa6c88bf5/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L299)
Locks all of the unlocked wallets, closes them, closes opened sessions and deletes the current Beekeeper API instance making it unusable
#### Returns
......@@ -45,7 +49,3 @@ Locks all of the unlocked wallets, closes them, closes opened sessions and delet
#### Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Source
[src/interfaces.ts:299](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/f8a89045f1ddce374b83e55aad21bd4418e71b9e/programs/beekeeper/beekeeper_wasm/src/interfaces.ts#L299)