@hiveio/beekeeper / IBeekeeperInstance

Interface: IBeekeeperInstance

Accessors

version

Get Signature

get version(): string

Retrieves the app build version of the Beekeeper API in SemVer format

Returns

string

the version of the Beekeeper API

Defined in

src/detailed/interfaces.ts:308

Methods

createSession()

createSession(salt): IBeekeeperSession

Creation of a session

Parameters

salt

string

a salt used for creation of a token

Returns

IBeekeeperSession

a beekeeper session created explicitly. It can be used for further work for example: creating/closing wallets, importing keys, signing transactions etc.

Throws

on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)

Defined in

src/detailed/interfaces.ts:301

delete()

delete(): Promise<void>

Locks all of the unlocked wallets, closes them, closes opened sessions and deletes the current Beekeeper API instance making it unusable

Returns

Promise<void>

Throws

on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)

Defined in

src/detailed/interfaces.ts:315