Skip to content
Snippets Groups Projects
Verified Commit 2f453c94 authored by Mateusz Tyszczak's avatar Mateusz Tyszczak :scroll:
Browse files

Fix minor node beekeeper documentation issues

parent 8a236ab9
No related branches found
No related tags found
3 merge requests!1506Changes made since last release,!1463Merge develop to master for release,!1206Fix minor node beekeeper documentation issues
Hide whitespace changes
Inline Side-by-side
programs/beekeeper/beekeeper_wasm/api.md
+ 45
− 35
View file @ 2f453c94
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
#### Defined in #### Defined in
src/interfaces.ts:1 src/interfaces.ts:4
___ ___
...@@ -32,21 +32,31 @@ ___ ...@@ -32,21 +32,31 @@ ___
#### Defined in #### Defined in
src/interfaces.ts:2 src/interfaces.ts:5
## Variables
### DEFAULT\_STORAGE\_ROOT
• `Const` **DEFAULT\_STORAGE\_ROOT**: ``"/storage_root"``
#### Defined in
src/web.ts:10
## Functions ## Functions
### default ### default
▸ **default**(`options?`): `Promise`\<[`IBeekeeperInstance`](#interfacesibeekeeperinstancemd)\> ▸ **default**(`...args`): `Promise`\<[`IBeekeeperInstance`](#interfacesibeekeeperinstancemd)\>
Creates a Beekeeper instance able to own sessions and wallets Creates a Beekeeper instance able to own sessions and wallets
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type |
| :------ | :------ | :------ | | :------ | :------ |
| `options` | `Partial`\<[`IBeekeeperOptions`](#interfacesibeekeeperoptionsmd)\> | options passed to the WASM Beekeeper | | `...args` | [options: Partial\<IBeekeeperOptions\>] |
#### Returns #### Returns
...@@ -60,7 +70,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -60,7 +70,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/detailed/beekeeper.web.ts:21 node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:365
<a name="interfacesibeekeeperinfomd"></a> <a name="interfacesibeekeeperinfomd"></a>
...@@ -79,7 +89,7 @@ Note: Time is in format: YYYY-MM-DDTHH:mm:ss ...@@ -79,7 +89,7 @@ Note: Time is in format: YYYY-MM-DDTHH:mm:ss
#### Defined in #### Defined in
src/interfaces.ts:31 src/interfaces.ts:34
___ ___
...@@ -93,7 +103,7 @@ Note: Time is in format: YYYY-MM-DDTHH:mm:ss ...@@ -93,7 +103,7 @@ Note: Time is in format: YYYY-MM-DDTHH:mm:ss
#### Defined in #### Defined in
src/interfaces.ts:40 src/interfaces.ts:43
<a name="interfacesibeekeeperinstancemd"></a> <a name="interfacesibeekeeperinstancemd"></a>
...@@ -126,7 +136,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -126,7 +136,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:232 src/interfaces.ts:235
___ ___
...@@ -146,7 +156,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -146,7 +156,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:239 src/interfaces.ts:242
<a name="interfacesibeekeeperoptionsmd"></a> <a name="interfacesibeekeeperoptionsmd"></a>
...@@ -169,7 +179,7 @@ true ...@@ -169,7 +179,7 @@ true
#### Defined in #### Defined in
src/interfaces.ts:58 src/interfaces.ts:61
___ ___
...@@ -183,7 +193,7 @@ Defaults to "/storage_root" for web and "." for web ...@@ -183,7 +193,7 @@ Defaults to "/storage_root" for web and "." for web
#### Defined in #### Defined in
src/interfaces.ts:51 src/interfaces.ts:54
___ ___
...@@ -203,7 +213,7 @@ Activity is defined as any wallet command e.g. list-wallets ...@@ -203,7 +213,7 @@ Activity is defined as any wallet command e.g. list-wallets
#### Defined in #### Defined in
src/interfaces.ts:68 src/interfaces.ts:71
<a name="interfacesibeekeepersessionmd"></a> <a name="interfacesibeekeepersessionmd"></a>
...@@ -230,7 +240,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -230,7 +240,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:219 src/interfaces.ts:222
___ ___
...@@ -259,7 +269,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -259,7 +269,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:190 src/interfaces.ts:193
___ ___
...@@ -281,7 +291,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -281,7 +291,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:169 src/interfaces.ts:172
___ ___
...@@ -303,7 +313,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -303,7 +313,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:178 src/interfaces.ts:181
___ ___
...@@ -325,7 +335,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -325,7 +335,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:210 src/interfaces.ts:213
___ ___
...@@ -353,7 +363,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -353,7 +363,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:201 src/interfaces.ts:204
<a name="interfacesibeekeeperunlockedwalletmd"></a> <a name="interfacesibeekeeperunlockedwalletmd"></a>
...@@ -380,7 +390,7 @@ Name of this wallet ...@@ -380,7 +390,7 @@ Name of this wallet
#### Defined in #### Defined in
src/interfaces.ts:20 src/interfaces.ts:23
## Methods ## Methods
...@@ -406,7 +416,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -406,7 +416,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:12 src/interfaces.ts:15
___ ___
...@@ -428,7 +438,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -428,7 +438,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:121 src/interfaces.ts:124
___ ___
...@@ -456,7 +466,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -456,7 +466,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:90 src/interfaces.ts:93
___ ___
...@@ -478,7 +488,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -478,7 +488,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:79 src/interfaces.ts:82
___ ___
...@@ -505,7 +515,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -505,7 +515,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:100 src/interfaces.ts:103
___ ___
...@@ -534,7 +544,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -534,7 +544,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:112 src/interfaces.ts:115
<a name="interfacesibeekeeperwalletmd"></a> <a name="interfacesibeekeeperwalletmd"></a>
...@@ -561,7 +571,7 @@ Name of this wallet ...@@ -561,7 +571,7 @@ Name of this wallet
#### Defined in #### Defined in
src/interfaces.ts:20 src/interfaces.ts:23
___ ___
...@@ -573,7 +583,7 @@ Indicates if the wallet is unlocked. If the wallet is locked, this property will ...@@ -573,7 +583,7 @@ Indicates if the wallet is unlocked. If the wallet is locked, this property will
#### Defined in #### Defined in
src/interfaces.ts:142 src/interfaces.ts:145
## Methods ## Methods
...@@ -599,7 +609,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -599,7 +609,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:12 src/interfaces.ts:15
___ ___
...@@ -627,7 +637,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -627,7 +637,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:134 src/interfaces.ts:137
<a name="interfacesiwalletmd"></a> <a name="interfacesiwalletmd"></a>
...@@ -652,7 +662,7 @@ Name of this wallet ...@@ -652,7 +662,7 @@ Name of this wallet
#### Defined in #### Defined in
src/interfaces.ts:20 src/interfaces.ts:23
## Methods ## Methods
...@@ -674,7 +684,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -674,7 +684,7 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
#### Defined in #### Defined in
src/interfaces.ts:12 src/interfaces.ts:15
<a name="interfacesiwalletcreatedmd"></a> <a name="interfacesiwalletcreatedmd"></a>
...@@ -691,7 +701,7 @@ Password used for unlocking your wallet ...@@ -691,7 +701,7 @@ Password used for unlocking your wallet
#### Defined in #### Defined in
src/interfaces.ts:158 src/interfaces.ts:161
___ ___
...@@ -703,4 +713,4 @@ Unlocked, ready to use wallet ...@@ -703,4 +713,4 @@ Unlocked, ready to use wallet
#### Defined in #### Defined in
src/interfaces.ts:151 src/interfaces.ts:154
programs/beekeeper/beekeeper_wasm/package.json
+ 2
− 1
View file @ 2f453c94
...@@ -40,7 +40,8 @@ ...@@ -40,7 +40,8 @@
"types": "./dist/bundle/node.d.ts", "types": "./dist/bundle/node.d.ts",
"default": "./dist/bundle/node.js" "default": "./dist/bundle/node.js"
} }
} },
"./package.json": "./package.json"
}, },
"files": [ "files": [
"LICENSE.md", "LICENSE.md",
......
programs/beekeeper/beekeeper_wasm/src/interfaces.ts
+ 18
− 15
View file @ 2f453c94
// @ts-expect-error ts(6133) Type BeekeeperError is used in JSDoc
import type { BeekeeperError } from "./errors";
export type TPublicKey = string; export type TPublicKey = string;
export type TSignature = string; export type TSignature = string;
...@@ -7,7 +10,7 @@ export interface IWallet { ...@@ -7,7 +10,7 @@ export interface IWallet {
* *
* @returns {IBeekeeperSession} Beekeeper session owning the closed wallet * @returns {IBeekeeperSession} Beekeeper session owning the closed wallet
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
close(): IBeekeeperSession; close(): IBeekeeperSession;
...@@ -74,7 +77,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet { ...@@ -74,7 +77,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
* *
* @returns {IBeekeeperWallet} Locked beekeeper wallet * @returns {IBeekeeperWallet} Locked beekeeper wallet
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
lock(): IBeekeeperWallet; lock(): IBeekeeperWallet;
...@@ -85,7 +88,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet { ...@@ -85,7 +88,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
* *
* @returns {Promise<TPublicKey>} Public key generated from the imported private key * @returns {Promise<TPublicKey>} Public key generated from the imported private key
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
importKey(wifKey: string): Promise<TPublicKey>; importKey(wifKey: string): Promise<TPublicKey>;
...@@ -95,7 +98,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet { ...@@ -95,7 +98,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
* @param {string} password password to the wallet * @param {string} password password to the wallet
* @param {TPublicKey} publicKey public key in WIF format to match the private key in the wallet to remove * @param {TPublicKey} publicKey public key in WIF format to match the private key in the wallet to remove
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
removeKey(password: string, publicKey: TPublicKey): Promise<void>; removeKey(password: string, publicKey: TPublicKey): Promise<void>;
...@@ -107,7 +110,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet { ...@@ -107,7 +110,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
* *
* @returns {TSignature} signed data in hex format * @returns {TSignature} signed data in hex format
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
signDigest(publicKey: TPublicKey, sigDigest: string): TSignature; signDigest(publicKey: TPublicKey, sigDigest: string): TSignature;
...@@ -116,7 +119,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet { ...@@ -116,7 +119,7 @@ export interface IBeekeeperUnlockedWallet extends IWallet {
* *
* @returns {TPublicKey[]} a set of all keys for all unlocked wallets * @returns {TPublicKey[]} a set of all keys for all unlocked wallets
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
getPublicKeys(): TPublicKey[]; getPublicKeys(): TPublicKey[];
} }
...@@ -129,7 +132,7 @@ export interface IBeekeeperWallet extends IWallet { ...@@ -129,7 +132,7 @@ export interface IBeekeeperWallet extends IWallet {
* *
* @returns {IBeekeeperUnlockedWallet} Unlocked Beekeeper wallet * @returns {IBeekeeperUnlockedWallet} Unlocked Beekeeper wallet
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
unlock(password: string): IBeekeeperUnlockedWallet; unlock(password: string): IBeekeeperUnlockedWallet;
...@@ -164,7 +167,7 @@ export interface IBeekeeperSession { ...@@ -164,7 +167,7 @@ export interface IBeekeeperSession {
* *
* @returns {IBeekeeperInfo} Current session information * @returns {IBeekeeperInfo} Current session information
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
getInfo(): IBeekeeperInfo; getInfo(): IBeekeeperInfo;
...@@ -173,7 +176,7 @@ export interface IBeekeeperSession { ...@@ -173,7 +176,7 @@ export interface IBeekeeperSession {
* *
* @returns {Array<IBeekeeperWallet>} array of opened Beekeeper wallets (either unlocked or locked) * @returns {Array<IBeekeeperWallet>} array of opened Beekeeper wallets (either unlocked or locked)
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
listWallets(): Array<IBeekeeperWallet>; listWallets(): Array<IBeekeeperWallet>;
...@@ -185,7 +188,7 @@ export interface IBeekeeperSession { ...@@ -185,7 +188,7 @@ export interface IBeekeeperSession {
* *
* @returns {Promise<IWalletCreated>} the created unlocked Beekeeper wallet object * @returns {Promise<IWalletCreated>} the created unlocked Beekeeper wallet object
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
createWallet(name: string, password?: string): Promise<IWalletCreated>; createWallet(name: string, password?: string): Promise<IWalletCreated>;
...@@ -196,7 +199,7 @@ export interface IBeekeeperSession { ...@@ -196,7 +199,7 @@ export interface IBeekeeperSession {
* *
* @returns {IBeekeeperWallet} the opened Beekeeper wallet object (may be unlocked if it has been previously unlocked) * @returns {IBeekeeperWallet} the opened Beekeeper wallet object (may be unlocked if it has been previously unlocked)
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
openWallet(name: string): IBeekeeperWallet; openWallet(name: string): IBeekeeperWallet;
...@@ -205,7 +208,7 @@ export interface IBeekeeperSession { ...@@ -205,7 +208,7 @@ export interface IBeekeeperSession {
* *
* @returns {Array<IBeekeeperWallet>} array of the locked Beekeeper wallets * @returns {Array<IBeekeeperWallet>} array of the locked Beekeeper wallets
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
lockAll(): Array<IBeekeeperWallet>; lockAll(): Array<IBeekeeperWallet>;
...@@ -214,7 +217,7 @@ export interface IBeekeeperSession { ...@@ -214,7 +217,7 @@ export interface IBeekeeperSession {
* *
* @returns {IBeekeeperInstance} Beekeeper instance owning the closed session * @returns {IBeekeeperInstance} Beekeeper instance owning the closed session
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
close(): IBeekeeperInstance; close(): IBeekeeperInstance;
} }
...@@ -227,14 +230,14 @@ export interface IBeekeeperInstance { ...@@ -227,14 +230,14 @@ export interface IBeekeeperInstance {
* *
* @returns {IBeekeeperSession} a beekeeper session created explicitly. It can be used for further work for example: creating/closing wallets, importing keys, signing transactions etc. * @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 {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
createSession(salt: string): IBeekeeperSession; createSession(salt: string): IBeekeeperSession;
/** /**
* Locks all of the unlocked wallets, closes them, closes opened sessions and deletes the current Beekeeper API instance making it unusable * Locks all of the unlocked wallets, closes them, closes opened sessions and deletes the current Beekeeper API instance making it unusable
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
delete(): Promise<void>; delete(): Promise<void>;
} }
programs/beekeeper/beekeeper_wasm/src/node.ts
+ 4
− 1
View file @ 2f453c94
// @ts-expect-error ts(6133) Type BeekeeperError is used in JSDoc
import type { BeekeeperError } from "./errors";
import createBeekeeperBase from "./detailed/beekeeper.js"; import createBeekeeperBase from "./detailed/beekeeper.js";
import Beekeeper from "./beekeeper.js"; import Beekeeper from "./beekeeper.js";
...@@ -13,7 +16,7 @@ export const DEFAULT_STORAGE_ROOT = "./storage_root-node"; ...@@ -13,7 +16,7 @@ export const DEFAULT_STORAGE_ROOT = "./storage_root-node";
* *
* @returns {Promise<IBeekeeperInstance>} Beekeeper API Instance * @returns {Promise<IBeekeeperInstance>} Beekeeper API Instance
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
const createBeekeeper = createBeekeeperBase.bind(undefined, Beekeeper, DEFAULT_STORAGE_ROOT); const createBeekeeper = createBeekeeperBase.bind(undefined, Beekeeper, DEFAULT_STORAGE_ROOT);
......
programs/beekeeper/beekeeper_wasm/src/web.ts
+ 4
− 1
View file @ 2f453c94
// @ts-expect-error ts(6133) Type BeekeeperError is used in JSDoc
import type { BeekeeperError } from "./errors";
import createBeekeeperBase from "./detailed/beekeeper.js"; import createBeekeeperBase from "./detailed/beekeeper.js";
import Beekeeper from "./beekeeper.js"; import Beekeeper from "./beekeeper.js";
...@@ -13,7 +16,7 @@ export const DEFAULT_STORAGE_ROOT = "/storage_root"; ...@@ -13,7 +16,7 @@ export const DEFAULT_STORAGE_ROOT = "/storage_root";
* *
* @returns {Promise<IBeekeeperInstance>} Beekeeper API Instance * @returns {Promise<IBeekeeperInstance>} Beekeeper API Instance
* *
* @throws {import("../errors").BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) * @throws {BeekeeperError} on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
*/ */
const createBeekeeper = createBeekeeperBase.bind(undefined, Beekeeper, DEFAULT_STORAGE_ROOT); const createBeekeeper = createBeekeeperBase.bind(undefined, Beekeeper, DEFAULT_STORAGE_ROOT);
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment