From af193b3b8da69b7b4885829be624919af167fe07 Mon Sep 17 00:00:00 2001 From: Jost Schulte Date: Wed, 17 Apr 2024 06:31:27 -0600 Subject: [PATCH] chore(release): v0.15.4 --- CHANGELOG.md | 4 + docs/index.md | 27 +- docs/tryorama.addallagentstoallconductors.md | 35 +- docs/tryorama.adminapiresponseagentinfo.md | 59 +- ...tryorama.adminapiresponseagentinfoadded.md | 41 +- ...ma.adminapiresponseagentpubkeygenerated.md | 59 +- docs/tryorama.adminapiresponseappdisabled.md | 59 +- docs/tryorama.adminapiresponseappenabled.md | 59 +- docs/tryorama.adminapiresponseappinstalled.md | 59 +- ...ma.adminapiresponseappinterfaceattached.md | 59 +- ...ama.adminapiresponseappinterfaceslisted.md | 59 +- docs/tryorama.adminapiresponseappslisted.md | 59 +- docs/tryorama.adminapiresponseappstarted.md | 59 +- ...tryorama.adminapiresponseappuninstalled.md | 59 +- .../tryorama.adminapiresponsecellidslisted.md | 59 +- ...yorama.adminapiresponseclonecelldeleted.md | 41 +- ...ama.adminapiresponsecoordinatorsupdated.md | 59 +- .../tryorama.adminapiresponsednaregistered.md | 59 +- ....adminapiresponsednasdefinitionreturned.md | 59 +- docs/tryorama.adminapiresponsednaslisted.md | 59 +- ...ryorama.adminapiresponsefullstatedumped.md | 59 +- ...rama.adminapiresponsenetworkstatsdumped.md | 59 +- docs/tryorama.adminapiresponsestatedumped.md | 59 +- docs/tryorama.adminapiresponsestorageinfo.md | 59 +- ...minapiresponsezomecallcapabilitygranted.md | 41 +- docs/tryorama.agentapp.md | 95 +- docs/tryorama.apierrorresponse.md | 59 +- docs/tryorama.appapiresponseappinfo.md | 59 +- ...tryorama.appapiresponseclonecellcreated.md | 59 +- ...ryorama.appapiresponseclonecelldisabled.md | 59 +- ...tryorama.appapiresponseclonecellenabled.md | 59 +- docs/tryorama.appapiresponsenetworkinfo.md | 59 +- docs/tryorama.appapiresponsezomecall.md | 59 +- docs/tryorama.appoptions.md | 123 +- docs/tryorama.areconductorcellsdhtssynced.md | 35 +- docs/tryorama.aredhtssynced.md | 48 +- docs/tryorama.clientplayers.md | 59 +- docs/tryorama.clientsplayersoptions.md | 163 +- docs/tryorama.conductor.attachappinterface.md | 35 +- docs/tryorama.conductor.connectappagentws.md | 52 +- docs/tryorama.conductor.connectappws.md | 35 +- docs/tryorama.conductor.create.md | 50 +- docs/tryorama.conductor.installagentsapps.md | 33 +- docs/tryorama.conductor.installapp.md | 52 +- docs/tryorama.conductor.md | 170 ++- docs/tryorama.conductorcellsdhtsync.md | 69 +- docs/tryorama.conductoroptions.md | 103 +- docs/tryorama.createconductor.md | 50 +- docs/tryorama.createtrycpconductor.md | 52 +- docs/tryorama.dhtsync.md | 86 +- docs/tryorama.dna.md | 101 +- docs/tryorama.enableandgetagentapp.md | 69 +- docs/tryorama.getcallablecell.md | 52 +- docs/tryorama.getzomecaller.md | 52 +- docs/tryorama.iconductor.md | 149 +- docs/tryorama.iconductorcell.md | 59 +- docs/tryorama.iplayer.md | 59 +- docs/tryorama.md | 1307 +++++++++++++++-- docs/tryorama.networktype.md | 48 +- docs/tryorama.pause.md | 35 +- docs/tryorama.player.md | 41 +- docs/tryorama.requestadmininterfacemessage.md | 61 +- docs/tryorama.requestappinfo.md | 59 +- docs/tryorama.requestcalladmininterface.md | 77 +- docs/tryorama.requestcallappinterface.md | 77 +- ...tryorama.requestcallappinterfaceencoded.md | 41 +- docs/tryorama.requestcallzome.md | 59 +- docs/tryorama.requestconfigureplayer.md | 77 +- docs/tryorama.requestconnectappinterface.md | 59 +- docs/tryorama.requestcreateclonecell.md | 59 +- docs/tryorama.requestdeleteclonecell.md | 59 +- docs/tryorama.requestdisableclonecell.md | 59 +- .../tryorama.requestdisconnectappinterface.md | 59 +- docs/tryorama.requestdownloaddna.md | 59 +- docs/tryorama.requestenableclonecell.md | 59 +- docs/tryorama.requestnetworkinfo.md | 59 +- docs/tryorama.requestreset.md | 41 +- docs/tryorama.requestsavedna.md | 77 +- docs/tryorama.requestshutdown.md | 79 +- docs/tryorama.requeststartup.md | 79 +- docs/tryorama.runscenario.md | 69 +- docs/tryorama.scenario._constructor_.md | 35 +- docs/tryorama.scenario.addplayerswithapps.md | 35 +- docs/tryorama.scenario.addplayerwithapp.md | 52 +- docs/tryorama.scenario.md | 256 +++- docs/tryorama.scenariooptions.md | 43 +- docs/tryorama.stoplocalservices.md | 33 +- docs/tryorama.trycpclient.addconductor.md | 35 +- docs/tryorama.trycpclient.call.md | 35 +- docs/tryorama.trycpclient.create.md | 52 +- docs/tryorama.trycpclient.md | 244 ++- docs/tryorama.trycpclient.ping.md | 35 +- docs/tryorama.trycpclient.setsignalhandler.md | 50 +- ...tryorama.trycpclient.unsetsignalhandler.md | 33 +- docs/tryorama.trycpconductor._constructor_.md | 50 +- docs/tryorama.trycpconductor.configure.md | 35 +- ...yorama.trycpconductor.connectappagentws.md | 48 +- ...rama.trycpconductor.connectappinterface.md | 35 +- docs/tryorama.trycpconductor.connectappws.md | 33 +- ...a.trycpconductor.disconnectappinterface.md | 35 +- docs/tryorama.trycpconductor.downloaddna.md | 33 +- ...yorama.trycpconductor.installagentsapps.md | 35 +- docs/tryorama.trycpconductor.installapp.md | 52 +- docs/tryorama.trycpconductor.md | 339 ++++- docs/tryorama.trycpconductor.off.md | 33 +- docs/tryorama.trycpconductor.on.md | 52 +- docs/tryorama.trycpconductor.savedna.md | 35 +- docs/tryorama.trycpconductor.startup.md | 35 +- docs/tryorama.trycpconductoroptions.md | 107 +- docs/tryorama.trycpplayer.md | 41 +- docs/tryorama.trycpscenario.addclient.md | 52 +- ...ryorama.trycpscenario.addclientsplayers.md | 52 +- ...yorama.trycpscenario.addplayerswithapps.md | 52 +- ...tryorama.trycpscenario.addplayerwithapp.md | 69 +- docs/tryorama.trycpscenario.md | 273 +++- docs/tryorama.trycpserver.md | 50 +- docs/tryorama.trycpserver.start.md | 35 +- 117 files changed, 8143 insertions(+), 649 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 87bc84e0..bb27ab30 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ### Changed ### Fixed +## 2024-04-17: v0.15.4 +### Fixed +- Replace all IPv4 addresses `127.0.0.1` by `localhost`. + ## 2024-02-28: v0.15.3 ### Changed - Update JS client to v0.16.0 diff --git a/docs/index.md b/docs/index.md index f19d2584..23c438e2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,28 @@ ## Packages -| Package | Description | -| --- | --- | -| [@holochain/tryorama](./tryorama.md) |

Tryorama

Tools for managing Holochain [Conductors](./tryorama.conductor.md) and [TryCP Conductors](./tryorama.trycpconductor.md).

| + + +
+Package + + + + +Description + + +
+ +[@holochain/tryorama](./tryorama.md) + + + + +Tryorama + +Tools for managing Holochain [Conductors](./tryorama.conductor.md) and [TryCP Conductors](./tryorama.trycpconductor.md). + + +
diff --git a/docs/tryorama.addallagentstoallconductors.md b/docs/tryorama.addallagentstoallconductors.md index d2759685..49b541a2 100644 --- a/docs/tryorama.addallagentstoallconductors.md +++ b/docs/tryorama.addallagentstoallconductors.md @@ -14,10 +14,39 @@ addAllAgentsToAllConductors: (conductors: IConductor[]) => Promise ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| conductors | [IConductor](./tryorama.iconductor.md)\[\] | Conductors to mutually exchange all agents with. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +conductors + + + + +[IConductor](./tryorama.iconductor.md)\[\] + + + + +Conductors to mutually exchange all agents with. + + +
**Returns:** Promise<void> diff --git a/docs/tryorama.adminapiresponseagentinfo.md b/docs/tryorama.adminapiresponseagentinfo.md index 15da1e60..097f52cf 100644 --- a/docs/tryorama.adminapiresponseagentinfo.md +++ b/docs/tryorama.adminapiresponseagentinfo.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAgentInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseagentinfo.data.md) | | AgentInfoResponse | | -| [type](./tryorama.adminapiresponseagentinfo.type.md) | | "agent\_info" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseagentinfo.data.md) + + + + + + + +AgentInfoResponse + + + + + +
+ +[type](./tryorama.adminapiresponseagentinfo.type.md) + + + + + + + +"agent\_info" + + + + + +
diff --git a/docs/tryorama.adminapiresponseagentinfoadded.md b/docs/tryorama.adminapiresponseagentinfoadded.md index ce575dab..7947936a 100644 --- a/docs/tryorama.adminapiresponseagentinfoadded.md +++ b/docs/tryorama.adminapiresponseagentinfoadded.md @@ -13,7 +13,42 @@ export interface AdminApiResponseAgentInfoAdded ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [type](./tryorama.adminapiresponseagentinfoadded.type.md) | | "agent\_info\_added" | | + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[type](./tryorama.adminapiresponseagentinfoadded.type.md) + + + + + + + +"agent\_info\_added" + + + + + +
diff --git a/docs/tryorama.adminapiresponseagentpubkeygenerated.md b/docs/tryorama.adminapiresponseagentpubkeygenerated.md index 6486c81a..c193b350 100644 --- a/docs/tryorama.adminapiresponseagentpubkeygenerated.md +++ b/docs/tryorama.adminapiresponseagentpubkeygenerated.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAgentPubKeyGenerated ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseagentpubkeygenerated.data.md) | | HoloHash | | -| [type](./tryorama.adminapiresponseagentpubkeygenerated.type.md) | | "agent\_pub\_key\_generated" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseagentpubkeygenerated.data.md) + + + + + + + +HoloHash + + + + + +
+ +[type](./tryorama.adminapiresponseagentpubkeygenerated.type.md) + + + + + + + +"agent\_pub\_key\_generated" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappdisabled.md b/docs/tryorama.adminapiresponseappdisabled.md index eecd3ffe..f814b7af 100644 --- a/docs/tryorama.adminapiresponseappdisabled.md +++ b/docs/tryorama.adminapiresponseappdisabled.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppDisabled ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappdisabled.data.md) | | DisableAppResponse | | -| [type](./tryorama.adminapiresponseappdisabled.type.md) | | "app\_disabled" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappdisabled.data.md) + + + + + + + +DisableAppResponse + + + + + +
+ +[type](./tryorama.adminapiresponseappdisabled.type.md) + + + + + + + +"app\_disabled" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappenabled.md b/docs/tryorama.adminapiresponseappenabled.md index fb4fcd16..75fe4b08 100644 --- a/docs/tryorama.adminapiresponseappenabled.md +++ b/docs/tryorama.adminapiresponseappenabled.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppEnabled ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappenabled.data.md) | | EnableAppResponse | | -| [type](./tryorama.adminapiresponseappenabled.type.md) | | "app\_enabled" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappenabled.data.md) + + + + + + + +EnableAppResponse + + + + + +
+ +[type](./tryorama.adminapiresponseappenabled.type.md) + + + + + + + +"app\_enabled" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappinstalled.md b/docs/tryorama.adminapiresponseappinstalled.md index c93db3ee..3eb82706 100644 --- a/docs/tryorama.adminapiresponseappinstalled.md +++ b/docs/tryorama.adminapiresponseappinstalled.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppInstalled ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappinstalled.data.md) | | AppInfo | | -| [type](./tryorama.adminapiresponseappinstalled.type.md) | | "app\_installed" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappinstalled.data.md) + + + + + + + +AppInfo + + + + + +
+ +[type](./tryorama.adminapiresponseappinstalled.type.md) + + + + + + + +"app\_installed" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappinterfaceattached.md b/docs/tryorama.adminapiresponseappinterfaceattached.md index 3fe9b07d..cb0c4d49 100644 --- a/docs/tryorama.adminapiresponseappinterfaceattached.md +++ b/docs/tryorama.adminapiresponseappinterfaceattached.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppInterfaceAttached ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappinterfaceattached.data.md) | | AttachAppInterfaceResponse | | -| [type](./tryorama.adminapiresponseappinterfaceattached.type.md) | | "app\_interface\_attached" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappinterfaceattached.data.md) + + + + + + + +AttachAppInterfaceResponse + + + + + +
+ +[type](./tryorama.adminapiresponseappinterfaceattached.type.md) + + + + + + + +"app\_interface\_attached" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappinterfaceslisted.md b/docs/tryorama.adminapiresponseappinterfaceslisted.md index 794597ba..97ed6326 100644 --- a/docs/tryorama.adminapiresponseappinterfaceslisted.md +++ b/docs/tryorama.adminapiresponseappinterfaceslisted.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppInterfacesListed ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappinterfaceslisted.data.md) | | ListAppInterfacesResponse | | -| [type](./tryorama.adminapiresponseappinterfaceslisted.type.md) | | "app\_interfaces\_listed" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappinterfaceslisted.data.md) + + + + + + + +ListAppInterfacesResponse + + + + + +
+ +[type](./tryorama.adminapiresponseappinterfaceslisted.type.md) + + + + + + + +"app\_interfaces\_listed" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappslisted.md b/docs/tryorama.adminapiresponseappslisted.md index e4a5dc7f..338bb712 100644 --- a/docs/tryorama.adminapiresponseappslisted.md +++ b/docs/tryorama.adminapiresponseappslisted.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppsListed ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappslisted.data.md) | | ListAppsResponse | | -| [type](./tryorama.adminapiresponseappslisted.type.md) | | "apps\_listed" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappslisted.data.md) + + + + + + + +ListAppsResponse + + + + + +
+ +[type](./tryorama.adminapiresponseappslisted.type.md) + + + + + + + +"apps\_listed" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappstarted.md b/docs/tryorama.adminapiresponseappstarted.md index c3a8d809..d052c3ab 100644 --- a/docs/tryorama.adminapiresponseappstarted.md +++ b/docs/tryorama.adminapiresponseappstarted.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppStarted ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappstarted.data.md) | | StartAppResponse | | -| [type](./tryorama.adminapiresponseappstarted.type.md) | | "app\_started" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappstarted.data.md) + + + + + + + +StartAppResponse + + + + + +
+ +[type](./tryorama.adminapiresponseappstarted.type.md) + + + + + + + +"app\_started" + + + + + +
diff --git a/docs/tryorama.adminapiresponseappuninstalled.md b/docs/tryorama.adminapiresponseappuninstalled.md index 1909e467..bbec56bf 100644 --- a/docs/tryorama.adminapiresponseappuninstalled.md +++ b/docs/tryorama.adminapiresponseappuninstalled.md @@ -13,8 +13,59 @@ export interface AdminApiResponseAppUninstalled ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponseappuninstalled.data.md) | | UninstallAppResponse | | -| [type](./tryorama.adminapiresponseappuninstalled.type.md) | | "app\_uninstalled" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponseappuninstalled.data.md) + + + + + + + +UninstallAppResponse + + + + + +
+ +[type](./tryorama.adminapiresponseappuninstalled.type.md) + + + + + + + +"app\_uninstalled" + + + + + +
diff --git a/docs/tryorama.adminapiresponsecellidslisted.md b/docs/tryorama.adminapiresponsecellidslisted.md index 2ca27cc6..2469986b 100644 --- a/docs/tryorama.adminapiresponsecellidslisted.md +++ b/docs/tryorama.adminapiresponsecellidslisted.md @@ -13,8 +13,59 @@ export interface AdminApiResponseCellIdsListed ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsecellidslisted.data.md) | | ListCellIdsResponse | | -| [type](./tryorama.adminapiresponsecellidslisted.type.md) | | "cell\_ids\_listed" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsecellidslisted.data.md) + + + + + + + +ListCellIdsResponse + + + + + +
+ +[type](./tryorama.adminapiresponsecellidslisted.type.md) + + + + + + + +"cell\_ids\_listed" + + + + + +
diff --git a/docs/tryorama.adminapiresponseclonecelldeleted.md b/docs/tryorama.adminapiresponseclonecelldeleted.md index 33bf1838..1833a53f 100644 --- a/docs/tryorama.adminapiresponseclonecelldeleted.md +++ b/docs/tryorama.adminapiresponseclonecelldeleted.md @@ -13,7 +13,42 @@ export interface AdminApiResponseCloneCellDeleted ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [type](./tryorama.adminapiresponseclonecelldeleted.type.md) | | "clone\_cell\_deleted" | | + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[type](./tryorama.adminapiresponseclonecelldeleted.type.md) + + + + + + + +"clone\_cell\_deleted" + + + + + +
diff --git a/docs/tryorama.adminapiresponsecoordinatorsupdated.md b/docs/tryorama.adminapiresponsecoordinatorsupdated.md index 38201902..4a211733 100644 --- a/docs/tryorama.adminapiresponsecoordinatorsupdated.md +++ b/docs/tryorama.adminapiresponsecoordinatorsupdated.md @@ -13,8 +13,59 @@ export interface AdminApiResponseCoordinatorsUpdated ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsecoordinatorsupdated.data.md) | | UpdateCoordinatorsResponse | | -| [type](./tryorama.adminapiresponsecoordinatorsupdated.type.md) | | "coordinators\_updated" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsecoordinatorsupdated.data.md) + + + + + + + +UpdateCoordinatorsResponse + + + + + +
+ +[type](./tryorama.adminapiresponsecoordinatorsupdated.type.md) + + + + + + + +"coordinators\_updated" + + + + + +
diff --git a/docs/tryorama.adminapiresponsednaregistered.md b/docs/tryorama.adminapiresponsednaregistered.md index 6e72f050..34241ca7 100644 --- a/docs/tryorama.adminapiresponsednaregistered.md +++ b/docs/tryorama.adminapiresponsednaregistered.md @@ -13,8 +13,59 @@ export interface AdminApiResponseDnaRegistered ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsednaregistered.data.md) | | HoloHash | | -| [type](./tryorama.adminapiresponsednaregistered.type.md) | | "dna\_registered" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsednaregistered.data.md) + + + + + + + +HoloHash + + + + + +
+ +[type](./tryorama.adminapiresponsednaregistered.type.md) + + + + + + + +"dna\_registered" + + + + + +
diff --git a/docs/tryorama.adminapiresponsednasdefinitionreturned.md b/docs/tryorama.adminapiresponsednasdefinitionreturned.md index f9b12abe..ab0841eb 100644 --- a/docs/tryorama.adminapiresponsednasdefinitionreturned.md +++ b/docs/tryorama.adminapiresponsednasdefinitionreturned.md @@ -13,8 +13,59 @@ export interface AdminApiResponseDnasDefinitionReturned ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsednasdefinitionreturned.data.md) | | DnaDefinition | | -| [type](./tryorama.adminapiresponsednasdefinitionreturned.type.md) | | "dna\_definition\_returned" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsednasdefinitionreturned.data.md) + + + + + + + +DnaDefinition + + + + + +
+ +[type](./tryorama.adminapiresponsednasdefinitionreturned.type.md) + + + + + + + +"dna\_definition\_returned" + + + + + +
diff --git a/docs/tryorama.adminapiresponsednaslisted.md b/docs/tryorama.adminapiresponsednaslisted.md index 337f8c55..0aea59d3 100644 --- a/docs/tryorama.adminapiresponsednaslisted.md +++ b/docs/tryorama.adminapiresponsednaslisted.md @@ -13,8 +13,59 @@ export interface AdminApiResponseDnasListed ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsednaslisted.data.md) | | ListDnasResponse | | -| [type](./tryorama.adminapiresponsednaslisted.type.md) | | "dnas\_listed" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsednaslisted.data.md) + + + + + + + +ListDnasResponse + + + + + +
+ +[type](./tryorama.adminapiresponsednaslisted.type.md) + + + + + + + +"dnas\_listed" + + + + + +
diff --git a/docs/tryorama.adminapiresponsefullstatedumped.md b/docs/tryorama.adminapiresponsefullstatedumped.md index e0771092..95ca16cc 100644 --- a/docs/tryorama.adminapiresponsefullstatedumped.md +++ b/docs/tryorama.adminapiresponsefullstatedumped.md @@ -13,8 +13,59 @@ export interface AdminApiResponseFullStateDumped ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsefullstatedumped.data.md) | | FullStateDump | | -| [type](./tryorama.adminapiresponsefullstatedumped.type.md) | | "full\_state\_dumped" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsefullstatedumped.data.md) + + + + + + + +FullStateDump + + + + + +
+ +[type](./tryorama.adminapiresponsefullstatedumped.type.md) + + + + + + + +"full\_state\_dumped" + + + + + +
diff --git a/docs/tryorama.adminapiresponsenetworkstatsdumped.md b/docs/tryorama.adminapiresponsenetworkstatsdumped.md index 56ead062..e0987032 100644 --- a/docs/tryorama.adminapiresponsenetworkstatsdumped.md +++ b/docs/tryorama.adminapiresponsenetworkstatsdumped.md @@ -13,8 +13,59 @@ export interface AdminApiResponseNetworkStatsDumped ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsenetworkstatsdumped.data.md) | | DumpNetworkStatsResponse | | -| [type](./tryorama.adminapiresponsenetworkstatsdumped.type.md) | | "network\_stats\_dumped" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsenetworkstatsdumped.data.md) + + + + + + + +DumpNetworkStatsResponse + + + + + +
+ +[type](./tryorama.adminapiresponsenetworkstatsdumped.type.md) + + + + + + + +"network\_stats\_dumped" + + + + + +
diff --git a/docs/tryorama.adminapiresponsestatedumped.md b/docs/tryorama.adminapiresponsestatedumped.md index 481260e0..a21a88a0 100644 --- a/docs/tryorama.adminapiresponsestatedumped.md +++ b/docs/tryorama.adminapiresponsestatedumped.md @@ -13,8 +13,59 @@ export interface AdminApiResponseStateDumped ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsestatedumped.data.md) | | DumpStateResponse | | -| [type](./tryorama.adminapiresponsestatedumped.type.md) | | "state\_dumped" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsestatedumped.data.md) + + + + + + + +DumpStateResponse + + + + + +
+ +[type](./tryorama.adminapiresponsestatedumped.type.md) + + + + + + + +"state\_dumped" + + + + + +
diff --git a/docs/tryorama.adminapiresponsestorageinfo.md b/docs/tryorama.adminapiresponsestorageinfo.md index 7bfd92d9..88a07d9c 100644 --- a/docs/tryorama.adminapiresponsestorageinfo.md +++ b/docs/tryorama.adminapiresponsestorageinfo.md @@ -13,8 +13,59 @@ export interface AdminApiResponseStorageInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.adminapiresponsestorageinfo.data.md) | | StorageInfoResponse | | -| [type](./tryorama.adminapiresponsestorageinfo.type.md) | | "storage\_info" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.adminapiresponsestorageinfo.data.md) + + + + + + + +StorageInfoResponse + + + + + +
+ +[type](./tryorama.adminapiresponsestorageinfo.type.md) + + + + + + + +"storage\_info" + + + + + +
diff --git a/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md b/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md index 2d4e315b..95311f10 100644 --- a/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md +++ b/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md @@ -13,7 +13,42 @@ export interface AdminApiResponseZomeCallCapabilityGranted ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [type](./tryorama.adminapiresponsezomecallcapabilitygranted.type.md) | | "zome\_call\_capability\_granted" | | + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[type](./tryorama.adminapiresponsezomecallcapabilitygranted.type.md) + + + + + + + +"zome\_call\_capability\_granted" + + + + + +
diff --git a/docs/tryorama.agentapp.md b/docs/tryorama.agentapp.md index 2524b422..6938ecf9 100644 --- a/docs/tryorama.agentapp.md +++ b/docs/tryorama.agentapp.md @@ -14,10 +14,93 @@ export interface AgentApp ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agentPubKey](./tryorama.agentapp.agentpubkey.md) | | Uint8Array | | -| [appId](./tryorama.agentapp.appid.md) | | string | | -| [cells](./tryorama.agentapp.cells.md) | | [CallableCell](./tryorama.callablecell.md)\[\] | | -| [namedCells](./tryorama.agentapp.namedcells.md) | | Map<RoleName, [CallableCell](./tryorama.callablecell.md)> | | + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agentPubKey](./tryorama.agentapp.agentpubkey.md) + + + + + + + +Uint8Array + + + + + +
+ +[appId](./tryorama.agentapp.appid.md) + + + + + + + +string + + + + + +
+ +[cells](./tryorama.agentapp.cells.md) + + + + + + + +[CallableCell](./tryorama.callablecell.md)\[\] + + + + + +
+ +[namedCells](./tryorama.agentapp.namedcells.md) + + + + + + + +Map<RoleName, [CallableCell](./tryorama.callablecell.md)> + + + + + +
diff --git a/docs/tryorama.apierrorresponse.md b/docs/tryorama.apierrorresponse.md index cd75544d..7d8403d2 100644 --- a/docs/tryorama.apierrorresponse.md +++ b/docs/tryorama.apierrorresponse.md @@ -14,8 +14,59 @@ export interface ApiErrorResponse ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.apierrorresponse.data.md) | | { type: string; data: string; } | | -| [type](./tryorama.apierrorresponse.type.md) | | "error" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.apierrorresponse.data.md) + + + + + + + +{ type: string; data: string; } + + + + + +
+ +[type](./tryorama.apierrorresponse.type.md) + + + + + + + +"error" + + + + + +
diff --git a/docs/tryorama.appapiresponseappinfo.md b/docs/tryorama.appapiresponseappinfo.md index 1c8149b0..f21c9494 100644 --- a/docs/tryorama.appapiresponseappinfo.md +++ b/docs/tryorama.appapiresponseappinfo.md @@ -13,8 +13,59 @@ export interface AppApiResponseAppInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.appapiresponseappinfo.data.md) | | AppInfoResponse | | -| [type](./tryorama.appapiresponseappinfo.type.md) | | "app\_info" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.appapiresponseappinfo.data.md) + + + + + + + +AppInfoResponse + + + + + +
+ +[type](./tryorama.appapiresponseappinfo.type.md) + + + + + + + +"app\_info" + + + + + +
diff --git a/docs/tryorama.appapiresponseclonecellcreated.md b/docs/tryorama.appapiresponseclonecellcreated.md index efc9d6e5..e7de97ff 100644 --- a/docs/tryorama.appapiresponseclonecellcreated.md +++ b/docs/tryorama.appapiresponseclonecellcreated.md @@ -13,8 +13,59 @@ export interface AppApiResponseCloneCellCreated ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.appapiresponseclonecellcreated.data.md) | | CreateCloneCellResponse | | -| [type](./tryorama.appapiresponseclonecellcreated.type.md) | | "clone\_cell\_created" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.appapiresponseclonecellcreated.data.md) + + + + + + + +CreateCloneCellResponse + + + + + +
+ +[type](./tryorama.appapiresponseclonecellcreated.type.md) + + + + + + + +"clone\_cell\_created" + + + + + +
diff --git a/docs/tryorama.appapiresponseclonecelldisabled.md b/docs/tryorama.appapiresponseclonecelldisabled.md index d74fa475..0855544a 100644 --- a/docs/tryorama.appapiresponseclonecelldisabled.md +++ b/docs/tryorama.appapiresponseclonecelldisabled.md @@ -13,8 +13,59 @@ export interface AppApiResponseCloneCellDisabled ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.appapiresponseclonecelldisabled.data.md) | | DisableCloneCellResponse | | -| [type](./tryorama.appapiresponseclonecelldisabled.type.md) | | "clone\_cell\_disabled" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.appapiresponseclonecelldisabled.data.md) + + + + + + + +DisableCloneCellResponse + + + + + +
+ +[type](./tryorama.appapiresponseclonecelldisabled.type.md) + + + + + + + +"clone\_cell\_disabled" + + + + + +
diff --git a/docs/tryorama.appapiresponseclonecellenabled.md b/docs/tryorama.appapiresponseclonecellenabled.md index c876247f..2c403d1e 100644 --- a/docs/tryorama.appapiresponseclonecellenabled.md +++ b/docs/tryorama.appapiresponseclonecellenabled.md @@ -13,8 +13,59 @@ export interface AppApiResponseCloneCellEnabled ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.appapiresponseclonecellenabled.data.md) | | EnableCloneCellResponse | | -| [type](./tryorama.appapiresponseclonecellenabled.type.md) | | "clone\_cell\_enabled" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.appapiresponseclonecellenabled.data.md) + + + + + + + +EnableCloneCellResponse + + + + + +
+ +[type](./tryorama.appapiresponseclonecellenabled.type.md) + + + + + + + +"clone\_cell\_enabled" + + + + + +
diff --git a/docs/tryorama.appapiresponsenetworkinfo.md b/docs/tryorama.appapiresponsenetworkinfo.md index a1e44dc8..a720bde6 100644 --- a/docs/tryorama.appapiresponsenetworkinfo.md +++ b/docs/tryorama.appapiresponsenetworkinfo.md @@ -13,8 +13,59 @@ export interface AppApiResponseNetworkInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.appapiresponsenetworkinfo.data.md) | | NetworkInfoResponse | | -| [type](./tryorama.appapiresponsenetworkinfo.type.md) | | "network\_info" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.appapiresponsenetworkinfo.data.md) + + + + + + + +NetworkInfoResponse + + + + + +
+ +[type](./tryorama.appapiresponsenetworkinfo.type.md) + + + + + + + +"network\_info" + + + + + +
diff --git a/docs/tryorama.appapiresponsezomecall.md b/docs/tryorama.appapiresponsezomecall.md index eaff975f..e463272b 100644 --- a/docs/tryorama.appapiresponsezomecall.md +++ b/docs/tryorama.appapiresponsezomecall.md @@ -13,8 +13,59 @@ export interface AppApiResponseZomeCall ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.appapiresponsezomecall.data.md) | | Uint8Array | | -| [type](./tryorama.appapiresponsezomecall.type.md) | | "zome\_call" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.appapiresponsezomecall.data.md) + + + + + + + +Uint8Array + + + + + +
+ +[type](./tryorama.appapiresponsezomecall.type.md) + + + + + + + +"zome\_call" + + + + + +
diff --git a/docs/tryorama.appoptions.md b/docs/tryorama.appoptions.md index 5beb0955..33f430da 100644 --- a/docs/tryorama.appoptions.md +++ b/docs/tryorama.appoptions.md @@ -14,11 +14,120 @@ export interface AppOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agentPubKey?](./tryorama.appoptions.agentpubkey.md) | | AgentPubKey | _(Optional)_ | -| [installedAppId?](./tryorama.appoptions.installedappid.md) | | string | _(Optional)_ App ID to override the app manifest's app name. | -| [membraneProofs?](./tryorama.appoptions.membraneproofs.md) | | Record<string, MembraneProof> | _(Optional)_ Proofs of membership for the hApp. | -| [networkSeed?](./tryorama.appoptions.networkseed.md) | | string | _(Optional)_ A network seed to override the hApps' network seed. | -| [signalHandler?](./tryorama.appoptions.signalhandler.md) | | AppSignalCb | _(Optional)_ A signal handler for the conductor. | + + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agentPubKey?](./tryorama.appoptions.agentpubkey.md) + + + + + + + +AgentPubKey + + + + +_(Optional)_ + + +
+ +[installedAppId?](./tryorama.appoptions.installedappid.md) + + + + + + + +string + + + + +_(Optional)_ App ID to override the app manifest's app name. + + +
+ +[membraneProofs?](./tryorama.appoptions.membraneproofs.md) + + + + + + + +Record<string, MembraneProof> + + + + +_(Optional)_ Proofs of membership for the hApp. + + +
+ +[networkSeed?](./tryorama.appoptions.networkseed.md) + + + + + + + +string + + + + +_(Optional)_ A network seed to override the hApps' network seed. + + +
+ +[signalHandler?](./tryorama.appoptions.signalhandler.md) + + + + + + + +AppSignalCb + + + + +_(Optional)_ A signal handler for the conductor. + + +
diff --git a/docs/tryorama.areconductorcellsdhtssynced.md b/docs/tryorama.areconductorcellsdhtssynced.md index 60df45d4..2db79428 100644 --- a/docs/tryorama.areconductorcellsdhtssynced.md +++ b/docs/tryorama.areconductorcellsdhtssynced.md @@ -14,10 +14,39 @@ areConductorCellsDhtsSynced: (conductorCells: IConductorCell[]) => Promise\[\] | Array of ConductorCells | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +conductorCells + + + + +[IConductorCell](./tryorama.iconductorcell.md)\[\] + + + + +Array of ConductorCells + + +
**Returns:** Promise<boolean> diff --git a/docs/tryorama.aredhtssynced.md b/docs/tryorama.aredhtssynced.md index 1e3223a7..95acc7da 100644 --- a/docs/tryorama.aredhtssynced.md +++ b/docs/tryorama.aredhtssynced.md @@ -14,11 +14,51 @@ areDhtsSynced: (players: IPlayer[], dnaHash: DnaHash) => Promise ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| players | [IPlayer](./tryorama.iplayer.md)\[\] | | -| dnaHash | DnaHash | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +players + + + + +[IPlayer](./tryorama.iplayer.md)\[\] + + + + + +
+ +dnaHash + + + + +DnaHash + + + + + +
**Returns:** Promise<boolean> diff --git a/docs/tryorama.clientplayers.md b/docs/tryorama.clientplayers.md index 83d247da..36b30ea0 100644 --- a/docs/tryorama.clientplayers.md +++ b/docs/tryorama.clientplayers.md @@ -14,8 +14,59 @@ export interface ClientPlayers ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [client](./tryorama.clientplayers.client.md) | | [TryCpClient](./tryorama.trycpclient.md) | | -| [players](./tryorama.clientplayers.players.md) | | [TryCpPlayer](./tryorama.trycpplayer.md)\[\] | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[client](./tryorama.clientplayers.client.md) + + + + + + + +[TryCpClient](./tryorama.trycpclient.md) + + + + + +
+ +[players](./tryorama.clientplayers.players.md) + + + + + + + +[TryCpPlayer](./tryorama.trycpplayer.md)\[\] + + + + + +
diff --git a/docs/tryorama.clientsplayersoptions.md b/docs/tryorama.clientsplayersoptions.md index 77a7dc12..d3657460 100644 --- a/docs/tryorama.clientsplayersoptions.md +++ b/docs/tryorama.clientsplayersoptions.md @@ -13,13 +13,158 @@ export interface ClientsPlayersOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agentPubKeys?](./tryorama.clientsplayersoptions.agentpubkeys.md) | | AgentPubKey\[\] | _(Optional)_ A list of previously generated agent pub keys (optional). | -| [app](./tryorama.clientsplayersoptions.app.md) | | AppBundleSource | An app that will be installed for each agent. | -| [clientTimeout?](./tryorama.clientsplayersoptions.clienttimeout.md) | | number | _(Optional)_ A timeout for the web socket connection (optional). | -| [numberOfAgentsPerConductor?](./tryorama.clientsplayersoptions.numberofagentsperconductor.md) | | number | _(Optional)_ Number of agents per conductor. Defaults to 1. | -| [numberOfConductorsPerClient?](./tryorama.clientsplayersoptions.numberofconductorsperclient.md) | | number | _(Optional)_ Number of conductors per client. Defaults to 1. | -| [partialConfig?](./tryorama.clientsplayersoptions.partialconfig.md) | | string | _(Optional)_ Configuration for the conductor (optional). | -| [signalHandler?](./tryorama.clientsplayersoptions.signalhandler.md) | | AppSignalCb | _(Optional)_ A signal handler to be registered in conductors. | + + + + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agentPubKeys?](./tryorama.clientsplayersoptions.agentpubkeys.md) + + + + + + + +AgentPubKey\[\] + + + + +_(Optional)_ A list of previously generated agent pub keys (optional). + + +
+ +[app](./tryorama.clientsplayersoptions.app.md) + + + + + + + +AppBundleSource + + + + +An app that will be installed for each agent. + + +
+ +[clientTimeout?](./tryorama.clientsplayersoptions.clienttimeout.md) + + + + + + + +number + + + + +_(Optional)_ A timeout for the web socket connection (optional). + + +
+ +[numberOfAgentsPerConductor?](./tryorama.clientsplayersoptions.numberofagentsperconductor.md) + + + + + + + +number + + + + +_(Optional)_ Number of agents per conductor. Defaults to 1. + + +
+ +[numberOfConductorsPerClient?](./tryorama.clientsplayersoptions.numberofconductorsperclient.md) + + + + + + + +number + + + + +_(Optional)_ Number of conductors per client. Defaults to 1. + + +
+ +[partialConfig?](./tryorama.clientsplayersoptions.partialconfig.md) + + + + + + + +string + + + + +_(Optional)_ Configuration for the conductor (optional). + + +
+ +[signalHandler?](./tryorama.clientsplayersoptions.signalhandler.md) + + + + + + + +AppSignalCb + + + + +_(Optional)_ A signal handler to be registered in conductors. + + +
diff --git a/docs/tryorama.conductor.attachappinterface.md b/docs/tryorama.conductor.attachappinterface.md index 0bd44cfb..99215737 100644 --- a/docs/tryorama.conductor.attachappinterface.md +++ b/docs/tryorama.conductor.attachappinterface.md @@ -14,10 +14,39 @@ attachAppInterface(request?: AttachAppInterfaceRequest): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| request | AttachAppInterfaceRequest | _(Optional)_ Specify a port for the web socket (optional). | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +request + + + + +AttachAppInterfaceRequest + + + + +_(Optional)_ Specify a port for the web socket (optional). + + +
**Returns:** Promise<number> diff --git a/docs/tryorama.conductor.connectappagentws.md b/docs/tryorama.conductor.connectappagentws.md index f4c7abf6..d2edddd8 100644 --- a/docs/tryorama.conductor.connectappagentws.md +++ b/docs/tryorama.conductor.connectappagentws.md @@ -14,11 +14,55 @@ connectAppAgentWs(port: number, appId: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | The websocket port to connect to. | -| appId | string | The app id to make requests to. | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + +The websocket port to connect to. + + +
+ +appId + + + + +string + + + + +The app id to make requests to. + + +
**Returns:** Promise<AppAgentWebsocket> diff --git a/docs/tryorama.conductor.connectappws.md b/docs/tryorama.conductor.connectappws.md index a0425171..56401c28 100644 --- a/docs/tryorama.conductor.connectappws.md +++ b/docs/tryorama.conductor.connectappws.md @@ -14,10 +14,39 @@ connectAppWs(port: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | The websocket port to connect to. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + +The websocket port to connect to. + + +
**Returns:** Promise<AppWebsocket> diff --git a/docs/tryorama.conductor.create.md b/docs/tryorama.conductor.create.md index 214bcb7c..61f2a7e4 100644 --- a/docs/tryorama.conductor.create.md +++ b/docs/tryorama.conductor.create.md @@ -14,11 +14,53 @@ static create(signalingServerUrl: URL, options?: CreateConductorOptions): Promis ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| signalingServerUrl | URL | | -| options | [CreateConductorOptions](./tryorama.createconductoroptions.md) | _(Optional)_ | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +signalingServerUrl + + + + +URL + + + + + +
+ +options + + + + +[CreateConductorOptions](./tryorama.createconductoroptions.md) + + + + +_(Optional)_ + + +
**Returns:** Promise<[Conductor](./tryorama.conductor.md)> diff --git a/docs/tryorama.conductor.installagentsapps.md b/docs/tryorama.conductor.installagentsapps.md index 77a9cb17..2566740d 100644 --- a/docs/tryorama.conductor.installagentsapps.md +++ b/docs/tryorama.conductor.installagentsapps.md @@ -14,10 +14,37 @@ installAgentsApps(options: AgentsAppsOptions): Promise +Parameter + + + + +Type + + + + +Description + + + + + +options + + + + +[AgentsAppsOptions](./tryorama.agentsappsoptions.md) + + + + + + + **Returns:** Promise<import("@holochain/client").AppInfo\[\]> diff --git a/docs/tryorama.conductor.installapp.md b/docs/tryorama.conductor.installapp.md index ef887e25..6db0c299 100644 --- a/docs/tryorama.conductor.installapp.md +++ b/docs/tryorama.conductor.installapp.md @@ -14,11 +14,55 @@ installApp(appBundleSource: AppBundleSource, options?: AppOptions): Promise +Parameter + + + + +Type + + + + +Description + + + + + +appBundleSource + + + + +AppBundleSource + + + + +The bundle or path to the bundle. + + + + + +options + + + + +[AppOptions](./tryorama.appoptions.md) + + + + +_(Optional)_ [AppOptions](./tryorama.appoptions.md) for the hApp bundle (optional). + + + + **Returns:** Promise<import("@holochain/client").AppInfo> diff --git a/docs/tryorama.conductor.md b/docs/tryorama.conductor.md index 3aa5e9eb..595a41a8 100644 --- a/docs/tryorama.conductor.md +++ b/docs/tryorama.conductor.md @@ -15,16 +15,162 @@ export declare class Conductor implements IConductor ## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [adminWs()](./tryorama.conductor.adminws.md) | | Get all Admin API methods. | -| [attachAppInterface(request)](./tryorama.conductor.attachappinterface.md) | | Attach a web socket to the App API. | -| [connectAppAgentWs(port, appId)](./tryorama.conductor.connectappagentws.md) | | Connect a web socket for a specific app and agent to the App API, | -| [connectAppWs(port)](./tryorama.conductor.connectappws.md) | | Connect a web socket to the App API, | -| [create(signalingServerUrl, options)](./tryorama.conductor.create.md) | static | Factory to create a conductor. | -| [getTmpDirectory()](./tryorama.conductor.gettmpdirectory.md) | | Get the path of the directory that contains all files and folders of the conductor. | -| [installAgentsApps(options)](./tryorama.conductor.installagentsapps.md) | | Install an app for multiple agents into the conductor. | -| [installApp(appBundleSource, options)](./tryorama.conductor.installapp.md) | | Install an application into the conductor. | -| [shutDown()](./tryorama.conductor.shutdown.md) | | Close Admin and App API connections and kill the conductor process. | -| [startUp()](./tryorama.conductor.startup.md) | | Start the conductor and establish a web socket connection to the Admin API. | + + + + + + + + + + + +
+Method + + + + +Modifiers + + + + +Description + + +
+ +[adminWs()](./tryorama.conductor.adminws.md) + + + + + + + +Get all Admin API methods. + + +
+ +[attachAppInterface(request)](./tryorama.conductor.attachappinterface.md) + + + + + + + +Attach a web socket to the App API. + + +
+ +[connectAppAgentWs(port, appId)](./tryorama.conductor.connectappagentws.md) + + + + + + + +Connect a web socket for a specific app and agent to the App API, + + +
+ +[connectAppWs(port)](./tryorama.conductor.connectappws.md) + + + + + + + +Connect a web socket to the App API, + + +
+ +[create(signalingServerUrl, options)](./tryorama.conductor.create.md) + + + + +`static` + + + + +Factory to create a conductor. + + +
+ +[getTmpDirectory()](./tryorama.conductor.gettmpdirectory.md) + + + + + + + +Get the path of the directory that contains all files and folders of the conductor. + + +
+ +[installAgentsApps(options)](./tryorama.conductor.installagentsapps.md) + + + + + + + +Install an app for multiple agents into the conductor. + + +
+ +[installApp(appBundleSource, options)](./tryorama.conductor.installapp.md) + + + + + + + +Install an application into the conductor. + + +
+ +[shutDown()](./tryorama.conductor.shutdown.md) + + + + + + + +Close Admin and App API connections and kill the conductor process. + + +
+ +[startUp()](./tryorama.conductor.startup.md) + + + + + + + +Start the conductor and establish a web socket connection to the Admin API. + + +
diff --git a/docs/tryorama.conductorcellsdhtsync.md b/docs/tryorama.conductorcellsdhtsync.md index 515e21d2..80cafd23 100644 --- a/docs/tryorama.conductorcellsdhtsync.md +++ b/docs/tryorama.conductorcellsdhtsync.md @@ -14,12 +14,71 @@ conductorCellsDhtSync: (conductorCells: IConductorCell[], interval?: number, tim ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| conductorCells | [IConductorCell](./tryorama.iconductorcell.md)\[\] | Array of IConductorCell. | -| interval | number | _(Optional)_ Interval to pause between comparisons (defaults to 50 ms). | -| timeout | number | _(Optional)_ A timeout for the delay (optional). | + + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +conductorCells + + + + +[IConductorCell](./tryorama.iconductorcell.md)\[\] + + + + +Array of IConductorCell. + + +
+ +interval + + + + +number + + + + +_(Optional)_ Interval to pause between comparisons (defaults to 50 ms). + + +
+ +timeout + + + + +number + + + + +_(Optional)_ A timeout for the delay (optional). + + +
**Returns:** Promise<void> diff --git a/docs/tryorama.conductoroptions.md b/docs/tryorama.conductoroptions.md index 529785ec..91b83f8c 100644 --- a/docs/tryorama.conductoroptions.md +++ b/docs/tryorama.conductoroptions.md @@ -13,10 +13,101 @@ export interface ConductorOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [bootstrapServerUrl?](./tryorama.conductoroptions.bootstrapserverurl.md) | | URL | _(Optional)_ A bootstrap server URL for peers to discover each other. | -| [networkType?](./tryorama.conductoroptions.networktype.md) | | [NetworkType](./tryorama.networktype.md) | _(Optional)_ The network type the conductor should use. | -| [startup?](./tryorama.conductoroptions.startup.md) | | boolean | _(Optional)_ Start up conductor after creation. | -| [timeout?](./tryorama.conductoroptions.timeout.md) | | number | _(Optional)_ Timeout for requests to Admin and App API. | + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[bootstrapServerUrl?](./tryorama.conductoroptions.bootstrapserverurl.md) + + + + + + + +URL + + + + +_(Optional)_ A bootstrap server URL for peers to discover each other. + + +
+ +[networkType?](./tryorama.conductoroptions.networktype.md) + + + + + + + +[NetworkType](./tryorama.networktype.md) + + + + +_(Optional)_ The network type the conductor should use. + + +
+ +[startup?](./tryorama.conductoroptions.startup.md) + + + + + + + +boolean + + + + +_(Optional)_ Start up conductor after creation. + + +
+ +[timeout?](./tryorama.conductoroptions.timeout.md) + + + + + + + +number + + + + +_(Optional)_ Timeout for requests to Admin and App API. + + +
diff --git a/docs/tryorama.createconductor.md b/docs/tryorama.createconductor.md index a810377c..89838079 100644 --- a/docs/tryorama.createconductor.md +++ b/docs/tryorama.createconductor.md @@ -14,11 +14,53 @@ createConductor: (signalingServerUrl: URL, options?: ConductorOptions) => Promis ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| signalingServerUrl | URL | | -| options | [ConductorOptions](./tryorama.conductoroptions.md) | _(Optional)_ | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +signalingServerUrl + + + + +URL + + + + + +
+ +options + + + + +[ConductorOptions](./tryorama.conductoroptions.md) + + + + +_(Optional)_ + + +
**Returns:** Promise<[Conductor](./tryorama.conductor.md)> diff --git a/docs/tryorama.createtrycpconductor.md b/docs/tryorama.createtrycpconductor.md index 8a450f9c..1ebed896 100644 --- a/docs/tryorama.createtrycpconductor.md +++ b/docs/tryorama.createtrycpconductor.md @@ -14,11 +14,55 @@ createTryCpConductor: (tryCpClient: TryCpClient, options?: TryCpConductorOptions ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| tryCpClient | [TryCpClient](./tryorama.trycpclient.md) | The client connection to the TryCP server on which to create the conductor. | -| options | [TryCpConductorOptions](./tryorama.trycpconductoroptions.md) | _(Optional)_ | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +tryCpClient + + + + +[TryCpClient](./tryorama.trycpclient.md) + + + + +The client connection to the TryCP server on which to create the conductor. + + +
+ +options + + + + +[TryCpConductorOptions](./tryorama.trycpconductoroptions.md) + + + + +_(Optional)_ + + +
**Returns:** Promise<[TryCpConductor](./tryorama.trycpconductor.md)> diff --git a/docs/tryorama.dhtsync.md b/docs/tryorama.dhtsync.md index 0fdc90e3..137a7ab1 100644 --- a/docs/tryorama.dhtsync.md +++ b/docs/tryorama.dhtsync.md @@ -14,13 +14,87 @@ dhtSync: (players: IPlayer[], dnaHash: DnaHash, interval?: number, timeout?: num ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| players | [IPlayer](./tryorama.iplayer.md)\[\] | Array of players. | -| dnaHash | DnaHash | DNA hash to compare integrated DhtOps from. | -| interval | number | _(Optional)_ Interval to pause between comparisons (defaults to 50 ms). | -| timeout | number | _(Optional)_ A timeout for the delay (optional). | + + + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +players + + + + +[IPlayer](./tryorama.iplayer.md)\[\] + + + + +Array of players. + + +
+ +dnaHash + + + + +DnaHash + + + + +DNA hash to compare integrated DhtOps from. + + +
+ +interval + + + + +number + + + + +_(Optional)_ Interval to pause between comparisons (defaults to 50 ms). + + +
+ +timeout + + + + +number + + + + +_(Optional)_ A timeout for the delay (optional). + + +
**Returns:** Promise<void> diff --git a/docs/tryorama.dna.md b/docs/tryorama.dna.md index 41bf9af1..c061c54d 100644 --- a/docs/tryorama.dna.md +++ b/docs/tryorama.dna.md @@ -14,10 +14,99 @@ export interface Dna ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [membraneProof?](./tryorama.dna.membraneproof.md) | | MembraneProof | _(Optional)_ | -| [properties?](./tryorama.dna.properties.md) | | DnaProperties | _(Optional)_ | -| [roleName?](./tryorama.dna.rolename.md) | | string | _(Optional)_ | -| [source](./tryorama.dna.source.md) | | DnaSource | | + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[membraneProof?](./tryorama.dna.membraneproof.md) + + + + + + + +MembraneProof + + + + +_(Optional)_ + + +
+ +[properties?](./tryorama.dna.properties.md) + + + + + + + +DnaProperties + + + + +_(Optional)_ + + +
+ +[roleName?](./tryorama.dna.rolename.md) + + + + + + + +string + + + + +_(Optional)_ + + +
+ +[source](./tryorama.dna.source.md) + + + + + + + +DnaSource + + + + + +
diff --git a/docs/tryorama.enableandgetagentapp.md b/docs/tryorama.enableandgetagentapp.md index 3efda82f..d3f4e0ce 100644 --- a/docs/tryorama.enableandgetagentapp.md +++ b/docs/tryorama.enableandgetagentapp.md @@ -14,12 +14,71 @@ enableAndGetAgentApp: (adminWs: IAdminWebsocket, appWs: IAppWebsocket | IAppAgen ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| adminWs | [IAdminWebsocket](./tryorama.iadminwebsocket.md) | The admin websocket to use for admin requests. | -| appWs | [IAppWebsocket](./tryorama.iappwebsocket.md) \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) | The app websocket to use for app requests. | -| appInfo | AppInfo | The app info of the app to enable. | + + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +adminWs + + + + +[IAdminWebsocket](./tryorama.iadminwebsocket.md) + + + + +The admin websocket to use for admin requests. + + +
+ +appWs + + + + +[IAppWebsocket](./tryorama.iappwebsocket.md) \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) + + + + +The app websocket to use for app requests. + + +
+ +appInfo + + + + +AppInfo + + + + +The app info of the app to enable. + + +
**Returns:** Promise<[AgentApp](./tryorama.agentapp.md)> diff --git a/docs/tryorama.getcallablecell.md b/docs/tryorama.getcallablecell.md index 93b54298..094c097e 100644 --- a/docs/tryorama.getcallablecell.md +++ b/docs/tryorama.getcallablecell.md @@ -27,11 +27,55 @@ getCallableCell: (appWs: IAppWebsocket | IAppAgentWebsocket, cell: ClonedCell | ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| appWs | [IAppWebsocket](./tryorama.iappwebsocket.md) \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) | App websocket to use for calling zome. | -| cell | ClonedCell \| ProvisionedCell | Cell to bind zome call function to. | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +appWs + + + + +[IAppWebsocket](./tryorama.iappwebsocket.md) \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) + + + + +App websocket to use for calling zome. + + +
+ +cell + + + + +ClonedCell \| ProvisionedCell + + + + +Cell to bind zome call function to. + + +
**Returns:** { callZome: <T>(request: [CellZomeCallRequest](./tryorama.cellzomecallrequest.md), timeout?: number) => Promise<T>; cell\_id: import("@holochain/client").CellId; clone\_id: string; original\_dna\_hash: Uint8Array; dna\_modifiers: import("@holochain/client").DnaModifiers; name: string; enabled: boolean; } \| { callZome: <T>(request: [CellZomeCallRequest](./tryorama.cellzomecallrequest.md), timeout?: number) => Promise<T>; cell\_id: import("@holochain/client").CellId; dna\_modifiers: import("@holochain/client").DnaModifiers; name: string; } diff --git a/docs/tryorama.getzomecaller.md b/docs/tryorama.getzomecaller.md index 695fa3e2..daeac0ee 100644 --- a/docs/tryorama.getzomecaller.md +++ b/docs/tryorama.getzomecaller.md @@ -14,11 +14,55 @@ getZomeCaller: (cell: CallableCell, zomeName: string) => (fnName: string, pay ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| cell | [CallableCell](./tryorama.callablecell.md) | The cell to call the zome on. | -| zomeName | string | The name of the Zome to call. | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +cell + + + + +[CallableCell](./tryorama.callablecell.md) + + + + +The cell to call the zome on. + + +
+ +zomeName + + + + +string + + + + +The name of the Zome to call. + + +
**Returns:** <T>(fnName: string, payload?: unknown, timeout?: number) => Promise<T> diff --git a/docs/tryorama.iconductor.md b/docs/tryorama.iconductor.md index 1928d2c0..d5c9f383 100644 --- a/docs/tryorama.iconductor.md +++ b/docs/tryorama.iconductor.md @@ -14,13 +14,144 @@ export interface IConductor ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [adminWs](./tryorama.iconductor.adminws.md) | | () => [IAdminWebsocket](./tryorama.iadminwebsocket.md) | | -| [connectAppAgentWs](./tryorama.iconductor.connectappagentws.md) | | (port: number, appId: InstalledAppId) => Promise<[IAppAgentWebsocket](./tryorama.iappagentwebsocket.md)> | | -| [connectAppWs](./tryorama.iconductor.connectappws.md) | | (port: number) => Promise<[IAppWebsocket](./tryorama.iappwebsocket.md)> | | -| [installAgentsApps](./tryorama.iconductor.installagentsapps.md) | | (options: [AgentsAppsOptions](./tryorama.agentsappsoptions.md)) => Promise<AppInfo\[\]> | | -| [installApp](./tryorama.iconductor.installapp.md) | | (appBundleSource: AppBundleSource, options?: [AppOptions](./tryorama.appoptions.md)) => Promise<AppInfo> | | -| [shutDown](./tryorama.iconductor.shutdown.md) | | () => Promise<number \| null> | | -| [startUp](./tryorama.iconductor.startup.md) | | () => Promise<void \| null> | | + + + + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[adminWs](./tryorama.iconductor.adminws.md) + + + + + + + +() => [IAdminWebsocket](./tryorama.iadminwebsocket.md) + + + + + +
+ +[connectAppAgentWs](./tryorama.iconductor.connectappagentws.md) + + + + + + + +(port: number, appId: InstalledAppId) => Promise<[IAppAgentWebsocket](./tryorama.iappagentwebsocket.md)> + + + + + +
+ +[connectAppWs](./tryorama.iconductor.connectappws.md) + + + + + + + +(port: number) => Promise<[IAppWebsocket](./tryorama.iappwebsocket.md)> + + + + + +
+ +[installAgentsApps](./tryorama.iconductor.installagentsapps.md) + + + + + + + +(options: [AgentsAppsOptions](./tryorama.agentsappsoptions.md)) => Promise<AppInfo\[\]> + + + + + +
+ +[installApp](./tryorama.iconductor.installapp.md) + + + + + + + +(appBundleSource: AppBundleSource, options?: [AppOptions](./tryorama.appoptions.md)) => Promise<AppInfo> + + + + + +
+ +[shutDown](./tryorama.iconductor.shutdown.md) + + + + + + + +() => Promise<number \| null> + + + + + +
+ +[startUp](./tryorama.iconductor.startup.md) + + + + + + + +() => Promise<void \| null> + + + + + +
diff --git a/docs/tryorama.iconductorcell.md b/docs/tryorama.iconductorcell.md index f67cded0..06b61846 100644 --- a/docs/tryorama.iconductorcell.md +++ b/docs/tryorama.iconductorcell.md @@ -14,8 +14,59 @@ export interface IConductorCell ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [cellId](./tryorama.iconductorcell.cellid.md) | | CellId | | -| [conductor](./tryorama.iconductorcell.conductor.md) | | [IConductor](./tryorama.iconductor.md) | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[cellId](./tryorama.iconductorcell.cellid.md) + + + + + + + +CellId + + + + + +
+ +[conductor](./tryorama.iconductorcell.conductor.md) + + + + + + + +[IConductor](./tryorama.iconductor.md) + + + + + +
diff --git a/docs/tryorama.iplayer.md b/docs/tryorama.iplayer.md index fa8e6cb2..b7034dbd 100644 --- a/docs/tryorama.iplayer.md +++ b/docs/tryorama.iplayer.md @@ -15,8 +15,59 @@ export interface IPlayer extends AgentApp ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [appAgentWs](./tryorama.iplayer.appagentws.md) | | AppAgentWebsocket \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) | | -| [conductor](./tryorama.iplayer.conductor.md) | | [IConductor](./tryorama.iconductor.md) | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[appAgentWs](./tryorama.iplayer.appagentws.md) + + + + + + + +AppAgentWebsocket \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) + + + + + +
+ +[conductor](./tryorama.iplayer.conductor.md) + + + + + + + +[IConductor](./tryorama.iconductor.md) + + + + + +
diff --git a/docs/tryorama.md b/docs/tryorama.md index 843c4a94..3b05f2b9 100644 --- a/docs/tryorama.md +++ b/docs/tryorama.md @@ -14,135 +14,1206 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r ## Classes -| Class | Description | -| --- | --- | -| [Conductor](./tryorama.conductor.md) | A class to manage a conductor running on localhost. | -| [Scenario](./tryorama.scenario.md) | An abstraction of a test scenario to write tests against Holochain hApps, running on a local conductor. | -| [TryCpClient](./tryorama.trycpclient.md) |

A factory class to create client connections to a running TryCP server.

With a client, conductors on the server can ba configured, started and stopped. All valid Admin and App API commands can be sent to the server too.

| -| [TryCpConductor](./tryorama.trycpconductor.md) | A class to manage a conductor running on a TryCP server. | -| [TryCpScenario](./tryorama.trycpscenario.md) |

A test scenario abstraction with convenience functions to manage TryCP clients and players (agent + conductor).

Clients in turn help manage conductors on TryCP servers. Clients can be added to a scenario to keep track of all server connections. When finishing a test scenario, all conductors of all clients can be easily cleaned up and the client connections closed.

| -| [TryCpServer](./tryorama.trycpserver.md) | A factory class to start and stop local instances of the TryCP server. | + + + + + + + +
+ +Class + + + + +Description + + +
+ +[Conductor](./tryorama.conductor.md) + + + + +A class to manage a conductor running on localhost. + + +
+ +[Scenario](./tryorama.scenario.md) + + + + +An abstraction of a test scenario to write tests against Holochain hApps, running on a local conductor. + + +
+ +[TryCpClient](./tryorama.trycpclient.md) + + + + +A factory class to create client connections to a running TryCP server. + +With a client, conductors on the server can ba configured, started and stopped. All valid Admin and App API commands can be sent to the server too. + + +
+ +[TryCpConductor](./tryorama.trycpconductor.md) + + + + +A class to manage a conductor running on a TryCP server. + + +
+ +[TryCpScenario](./tryorama.trycpscenario.md) + + + + +A test scenario abstraction with convenience functions to manage TryCP clients and players (agent + conductor). + +Clients in turn help manage conductors on TryCP servers. Clients can be added to a scenario to keep track of all server connections. When finishing a test scenario, all conductors of all clients can be easily cleaned up and the client connections closed. + + +
+ +[TryCpServer](./tryorama.trycpserver.md) + + + + +A factory class to start and stop local instances of the TryCP server. + + +
## Enumerations -| Enumeration | Description | -| --- | --- | -| [NetworkType](./tryorama.networktype.md) | The network type the conductor should use to communicate with peers. | + + +
+ +Enumeration + + + + +Description + + +
+ +[NetworkType](./tryorama.networktype.md) + + + + +The network type the conductor should use to communicate with peers. + + +
## Functions -| Function | Description | -| --- | --- | -| [addAllAgentsToAllConductors(conductors)](./tryorama.addallagentstoallconductors.md) | Add all agents of all conductors to each other. Shortcuts peer discovery through a bootstrap server or gossiping. | -| [areConductorCellsDhtsSynced(conductorCells)](./tryorama.areconductorcellsdhtssynced.md) | A utility function to compare conductors' integrated DhtOps. | -| [areDhtsSynced(players, dnaHash)](./tryorama.aredhtssynced.md) | A utility function to compare conductors' integrated DhtOps. | -| [cleanAllConductors()](./tryorama.cleanallconductors.md) | Run the hc command to delete all conductor data. | -| [conductorCellsDhtSync(conductorCells, interval, timeout)](./tryorama.conductorcellsdhtsync.md) | A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. | -| [createConductor(signalingServerUrl, options)](./tryorama.createconductor.md) | The function to create a conductor. It starts a sandbox conductor via the Holochain CLI. | -| [createTryCpConductor(tryCpClient, options)](./tryorama.createtrycpconductor.md) | The function to create a TryCP Conductor. By default configures and starts it. | -| [dhtSync(players, dnaHash, interval, timeout)](./tryorama.dhtsync.md) | A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. | -| [enableAndGetAgentApp(adminWs, appWs, appInfo)](./tryorama.enableandgetagentapp.md) | Enable an app and build an agent app object. | -| [getCallableCell(appWs, cell)](./tryorama.getcallablecell.md) | Create curried version of callZome function for a specific cell. | -| [getZomeCaller(cell, zomeName)](./tryorama.getzomecaller.md) | Get a shorthand function to call a cell's zome. | -| [pause(milliseconds)](./tryorama.pause.md) | A utility function to wait the given amount of time. | -| [runLocalServices()](./tryorama.runlocalservices.md) | Spawn a signalling server to enable connections between conductors. | -| [runScenario(testScenario, cleanUp, options)](./tryorama.runscenario.md) | A wrapper function to create and run a scenario. A scenario is created and all involved conductors are shut down and cleaned up after running. | -| [stopLocalServices(localServicesProcess)](./tryorama.stoplocalservices.md) | Shutdown signalling server process. | + + + + + + + + + + + + + + + + +
+ +Function + + + + +Description + + +
+ +[addAllAgentsToAllConductors(conductors)](./tryorama.addallagentstoallconductors.md) + + + + +Add all agents of all conductors to each other. Shortcuts peer discovery through a bootstrap server or gossiping. + + +
+ +[areConductorCellsDhtsSynced(conductorCells)](./tryorama.areconductorcellsdhtssynced.md) + + + + +A utility function to compare conductors' integrated DhtOps. + + +
+ +[areDhtsSynced(players, dnaHash)](./tryorama.aredhtssynced.md) + + + + +A utility function to compare conductors' integrated DhtOps. + + +
+ +[cleanAllConductors()](./tryorama.cleanallconductors.md) + + + + +Run the `hc` command to delete all conductor data. + + +
+ +[conductorCellsDhtSync(conductorCells, interval, timeout)](./tryorama.conductorcellsdhtsync.md) + + + + +A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. + + +
+ +[createConductor(signalingServerUrl, options)](./tryorama.createconductor.md) + + + + +The function to create a conductor. It starts a sandbox conductor via the Holochain CLI. + + +
+ +[createTryCpConductor(tryCpClient, options)](./tryorama.createtrycpconductor.md) + + + + +The function to create a TryCP Conductor. By default configures and starts it. + + +
+ +[dhtSync(players, dnaHash, interval, timeout)](./tryorama.dhtsync.md) + + + + +A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. + + +
+ +[enableAndGetAgentApp(adminWs, appWs, appInfo)](./tryorama.enableandgetagentapp.md) + + + + +Enable an app and build an agent app object. + + +
+ +[getCallableCell(appWs, cell)](./tryorama.getcallablecell.md) + + + + +Create curried version of `callZome` function for a specific cell. + + +
+ +[getZomeCaller(cell, zomeName)](./tryorama.getzomecaller.md) + + + + +Get a shorthand function to call a cell's zome. + + +
+ +[pause(milliseconds)](./tryorama.pause.md) + + + + +A utility function to wait the given amount of time. + + +
+ +[runLocalServices()](./tryorama.runlocalservices.md) + + + + +Spawn a signalling server to enable connections between conductors. + + +
+ +[runScenario(testScenario, cleanUp, options)](./tryorama.runscenario.md) + + + + +A wrapper function to create and run a scenario. A scenario is created and all involved conductors are shut down and cleaned up after running. + + +
+ +[stopLocalServices(localServicesProcess)](./tryorama.stoplocalservices.md) + + + + +Shutdown signalling server process. + + +
## Interfaces -| Interface | Description | -| --- | --- | -| [AdminApiResponseAgentInfo](./tryorama.adminapiresponseagentinfo.md) | | -| [AdminApiResponseAgentInfoAdded](./tryorama.adminapiresponseagentinfoadded.md) | | -| [AdminApiResponseAgentPubKeyGenerated](./tryorama.adminapiresponseagentpubkeygenerated.md) | | -| [AdminApiResponseAppDisabled](./tryorama.adminapiresponseappdisabled.md) | | -| [AdminApiResponseAppEnabled](./tryorama.adminapiresponseappenabled.md) | | -| [AdminApiResponseAppInstalled](./tryorama.adminapiresponseappinstalled.md) | | -| [AdminApiResponseAppInterfaceAttached](./tryorama.adminapiresponseappinterfaceattached.md) | | -| [AdminApiResponseAppInterfacesListed](./tryorama.adminapiresponseappinterfaceslisted.md) | | -| [AdminApiResponseAppsListed](./tryorama.adminapiresponseappslisted.md) | | -| [AdminApiResponseAppStarted](./tryorama.adminapiresponseappstarted.md) | | -| [AdminApiResponseAppUninstalled](./tryorama.adminapiresponseappuninstalled.md) | | -| [AdminApiResponseCellIdsListed](./tryorama.adminapiresponsecellidslisted.md) | | -| [AdminApiResponseCloneCellDeleted](./tryorama.adminapiresponseclonecelldeleted.md) | | -| [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md) | | -| [AdminApiResponseDnaRegistered](./tryorama.adminapiresponsednaregistered.md) | | -| [AdminApiResponseDnasDefinitionReturned](./tryorama.adminapiresponsednasdefinitionreturned.md) | | -| [AdminApiResponseDnasListed](./tryorama.adminapiresponsednaslisted.md) | | -| [AdminApiResponseFullStateDumped](./tryorama.adminapiresponsefullstatedumped.md) | | -| [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md) | | -| [AdminApiResponseStateDumped](./tryorama.adminapiresponsestatedumped.md) | | -| [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md) | | -| [AdminApiResponseZomeCallCapabilityGranted](./tryorama.adminapiresponsezomecallcapabilitygranted.md) | | -| [AgentApp](./tryorama.agentapp.md) | Provides direct access to cells of an app and the agent key. | -| [ApiErrorResponse](./tryorama.apierrorresponse.md) | Error response from the Admin or App API. | -| [AppApiResponseAppInfo](./tryorama.appapiresponseappinfo.md) | | -| [AppApiResponseCloneCellCreated](./tryorama.appapiresponseclonecellcreated.md) | | -| [AppApiResponseCloneCellDisabled](./tryorama.appapiresponseclonecelldisabled.md) | | -| [AppApiResponseCloneCellEnabled](./tryorama.appapiresponseclonecellenabled.md) | | -| [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) | | -| [AppApiResponseZomeCall](./tryorama.appapiresponsezomecall.md) | | -| [AppOptions](./tryorama.appoptions.md) | Optional arguments when installing a hApp. | -| [ClientPlayers](./tryorama.clientplayers.md) | A TryCP client and its associated players. | -| [ClientsPlayersOptions](./tryorama.clientsplayersoptions.md) | | -| [ConductorOptions](./tryorama.conductoroptions.md) | | -| [Dna](./tryorama.dna.md) | DNA source and additional options. | -| [IConductor](./tryorama.iconductor.md) | Base interface of a Tryorama conductor. Both [Conductor](./tryorama.conductor.md) and [TryCpConductor](./tryorama.trycpconductor.md) implement this interface. | -| [IConductorCell](./tryorama.iconductorcell.md) | A Conductor and a CellId | -| [IPlayer](./tryorama.iplayer.md) | Combines an agent hApp with the conductor they belong to. | -| [Player](./tryorama.player.md) | A player tied to a [Conductor](./tryorama.conductor.md). | -| [RequestAdminInterfaceMessage](./tryorama.requestadmininterfacemessage.md) | All possible calls to the Admin API. | -| [RequestAppInfo](./tryorama.requestappinfo.md) | Request app info from a conductor. | -| [RequestCallAdminInterface](./tryorama.requestcalladmininterface.md) | Request a call to the Admin API. | -| [RequestCallAppInterface](./tryorama.requestcallappinterface.md) | Request a call to the App API. | -| [RequestCallAppInterfaceEncoded](./tryorama.requestcallappinterfaceencoded.md) | Msgpack encoded request to call an app interface. | -| [RequestCallZome](./tryorama.requestcallzome.md) | Request to call a zome on a conductor's app interface. | -| [RequestConfigurePlayer](./tryorama.requestconfigureplayer.md) | Request to create configuration files and directories for a conductor. | -| [RequestConnectAppInterface](./tryorama.requestconnectappinterface.md) | Request to connect an app interface to a conductor. | -| [RequestCreateCloneCell](./tryorama.requestcreateclonecell.md) | Create a clone cell. | -| [RequestDeleteCloneCell](./tryorama.requestdeleteclonecell.md) | Delete a disabled clone cell. | -| [RequestDisableCloneCell](./tryorama.requestdisableclonecell.md) | Disable a clone cell. | -| [RequestDisconnectAppInterface](./tryorama.requestdisconnectappinterface.md) | Request to disconnect a connected app interface from a conductor. | -| [RequestDownloadDna](./tryorama.requestdownloaddna.md) | Request to download a DNA from a URL. | -| [RequestEnableCloneCell](./tryorama.requestenableclonecell.md) | Enable a disabled clone cell. | -| [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) | Request network info. | -| [RequestReset](./tryorama.requestreset.md) | Request deletion of \*\*all\*\* conductors. | -| [RequestSaveDna](./tryorama.requestsavedna.md) | Request to save a DNA to the server's file system. | -| [RequestShutdown](./tryorama.requestshutdown.md) | Request shutdown of a conductor. | -| [RequestStartup](./tryorama.requeststartup.md) | Request startup of a conductor. | -| [ScenarioOptions](./tryorama.scenariooptions.md) | Options when creating a scenario. | -| [TryCpConductorOptions](./tryorama.trycpconductoroptions.md) | | -| [TryCpPlayer](./tryorama.trycpplayer.md) | A player tied to a [TryCpConductor](./tryorama.trycpconductor.md). | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-## Variables +Interface -| Variable | Description | -| --- | --- | -| [DEFAULT\_PARTIAL\_PLAYER\_CONFIG](./tryorama.default_partial_player_config.md) | The default partial config for a TryCP conductor. | -| [TRYCP\_SERVER\_HOST](./tryorama.trycp_server_host.md) | Default TryCP server host address. | -| [TRYCP\_SERVER\_PORT](./tryorama.trycp_server_port.md) | Default TryCP server port. | -| [TRYCP\_SUCCESS\_RESPONSE](./tryorama.trycp_success_response.md) | Empty success response. | -## Type Aliases + + +Description + + +
+ +[AdminApiResponseAgentInfo](./tryorama.adminapiresponseagentinfo.md) + + + + + + +
+ +[AdminApiResponseAgentInfoAdded](./tryorama.adminapiresponseagentinfoadded.md) + + + + + + +
+ +[AdminApiResponseAgentPubKeyGenerated](./tryorama.adminapiresponseagentpubkeygenerated.md) + + + + + + +
+ +[AdminApiResponseAppDisabled](./tryorama.adminapiresponseappdisabled.md) + + + + + + +
+ +[AdminApiResponseAppEnabled](./tryorama.adminapiresponseappenabled.md) + + + + + + +
+ +[AdminApiResponseAppInstalled](./tryorama.adminapiresponseappinstalled.md) + + + + + + +
+ +[AdminApiResponseAppInterfaceAttached](./tryorama.adminapiresponseappinterfaceattached.md) + + + + + + +
+ +[AdminApiResponseAppInterfacesListed](./tryorama.adminapiresponseappinterfaceslisted.md) + + + + + + +
+ +[AdminApiResponseAppsListed](./tryorama.adminapiresponseappslisted.md) + + + + + + +
+ +[AdminApiResponseAppStarted](./tryorama.adminapiresponseappstarted.md) + + + + + + +
+ +[AdminApiResponseAppUninstalled](./tryorama.adminapiresponseappuninstalled.md) + + + + + + +
+ +[AdminApiResponseCellIdsListed](./tryorama.adminapiresponsecellidslisted.md) + + + + + + +
+ +[AdminApiResponseCloneCellDeleted](./tryorama.adminapiresponseclonecelldeleted.md) + + + + + + +
+ +[AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md) + + + + + + +
+ +[AdminApiResponseDnaRegistered](./tryorama.adminapiresponsednaregistered.md) + + + + + + +
+ +[AdminApiResponseDnasDefinitionReturned](./tryorama.adminapiresponsednasdefinitionreturned.md) + + + + + + +
+ +[AdminApiResponseDnasListed](./tryorama.adminapiresponsednaslisted.md) + + + + + + +
+ +[AdminApiResponseFullStateDumped](./tryorama.adminapiresponsefullstatedumped.md) + + + + + + +
+ +[AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md) + + + + + + +
+ +[AdminApiResponseStateDumped](./tryorama.adminapiresponsestatedumped.md) + + + + + + +
+ +[AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md) + + + + + + +
+ +[AdminApiResponseZomeCallCapabilityGranted](./tryorama.adminapiresponsezomecallcapabilitygranted.md) + + + + + + +
+ +[AgentApp](./tryorama.agentapp.md) + + + + +Provides direct access to cells of an app and the agent key. + + +
+ +[ApiErrorResponse](./tryorama.apierrorresponse.md) + + + + +Error response from the Admin or App API. + + +
+ +[AppApiResponseAppInfo](./tryorama.appapiresponseappinfo.md) + + + + + + +
+ +[AppApiResponseCloneCellCreated](./tryorama.appapiresponseclonecellcreated.md) + + + + + + +
+ +[AppApiResponseCloneCellDisabled](./tryorama.appapiresponseclonecelldisabled.md) + + + + + + +
+ +[AppApiResponseCloneCellEnabled](./tryorama.appapiresponseclonecellenabled.md) + + + + + + +
+ +[AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) + + + + + + +
+ +[AppApiResponseZomeCall](./tryorama.appapiresponsezomecall.md) + + + + + + +
+ +[AppOptions](./tryorama.appoptions.md) + + + + +Optional arguments when installing a hApp. + + +
+ +[ClientPlayers](./tryorama.clientplayers.md) + + + + +A TryCP client and its associated players. + + +
+ +[ClientsPlayersOptions](./tryorama.clientsplayersoptions.md) + + + + + + +
+ +[ConductorOptions](./tryorama.conductoroptions.md) + + + + + + +
+ +[Dna](./tryorama.dna.md) + + + + +DNA source and additional options. + + +
+ +[IConductor](./tryorama.iconductor.md) + + + + +Base interface of a Tryorama conductor. Both [Conductor](./tryorama.conductor.md) and [TryCpConductor](./tryorama.trycpconductor.md) implement this interface. + + +
+ +[IConductorCell](./tryorama.iconductorcell.md) + + + + +A Conductor and a CellId + + +
+ +[IPlayer](./tryorama.iplayer.md) + + + + +Combines an agent hApp with the conductor they belong to. + + +
+ +[Player](./tryorama.player.md) + + + + +A player tied to a [Conductor](./tryorama.conductor.md). + + +
+ +[RequestAdminInterfaceMessage](./tryorama.requestadmininterfacemessage.md) + + + + +All possible calls to the Admin API. + + +
+ +[RequestAppInfo](./tryorama.requestappinfo.md) + + + + +Request app info from a conductor. + + +
+ +[RequestCallAdminInterface](./tryorama.requestcalladmininterface.md) + + + + +Request a call to the Admin API. + + +
+ +[RequestCallAppInterface](./tryorama.requestcallappinterface.md) + + + + +Request a call to the App API. + + +
+ +[RequestCallAppInterfaceEncoded](./tryorama.requestcallappinterfaceencoded.md) + + + + +Msgpack encoded request to call an app interface. + + +
+ +[RequestCallZome](./tryorama.requestcallzome.md) + + + + +Request to call a zome on a conductor's app interface. + + +
+ +[RequestConfigurePlayer](./tryorama.requestconfigureplayer.md) + + + + +Request to create configuration files and directories for a conductor. + + +
+ +[RequestConnectAppInterface](./tryorama.requestconnectappinterface.md) + + + + +Request to connect an app interface to a conductor. + + +
+ +[RequestCreateCloneCell](./tryorama.requestcreateclonecell.md) + + + + +Create a clone cell. + + +
+ +[RequestDeleteCloneCell](./tryorama.requestdeleteclonecell.md) + + + + +Delete a disabled clone cell. + + +
+ +[RequestDisableCloneCell](./tryorama.requestdisableclonecell.md) + + + + +Disable a clone cell. + + +
+ +[RequestDisconnectAppInterface](./tryorama.requestdisconnectappinterface.md) + + + + +Request to disconnect a connected app interface from a conductor. + + +
+ +[RequestDownloadDna](./tryorama.requestdownloaddna.md) + + + + +Request to download a DNA from a URL. + + +
+ +[RequestEnableCloneCell](./tryorama.requestenableclonecell.md) + + + + +Enable a disabled clone cell. + + +
+ +[RequestNetworkInfo](./tryorama.requestnetworkinfo.md) + + + + +Request network info. + + +
+ +[RequestReset](./tryorama.requestreset.md) + + + + +Request deletion of \*\*all\*\* conductors. + + +
+ +[RequestSaveDna](./tryorama.requestsavedna.md) + + + + +Request to save a DNA to the server's file system. + + +
+ +[RequestShutdown](./tryorama.requestshutdown.md) + + + + +Request shutdown of a conductor. + + +
+ +[RequestStartup](./tryorama.requeststartup.md) + + + + +Request startup of a conductor. + + +
+ +[ScenarioOptions](./tryorama.scenariooptions.md) + + + + +Options when creating a scenario. + + +
+ +[TryCpConductorOptions](./tryorama.trycpconductoroptions.md) + + + + + + +
+ +[TryCpPlayer](./tryorama.trycpplayer.md) + + + + +A player tied to a [TryCpConductor](./tryorama.trycpconductor.md). + + +
+ +## Variables + + + + + + +
+ +Variable + + + + +Description + + +
+ +[DEFAULT\_PARTIAL\_PLAYER\_CONFIG](./tryorama.default_partial_player_config.md) + + + + +The default partial config for a TryCP conductor. + + +
+ +[TRYCP\_SERVER\_HOST](./tryorama.trycp_server_host.md) + + + + +Default TryCP server host address. + + +
+ +[TRYCP\_SERVER\_PORT](./tryorama.trycp_server_port.md) + + + + +Default TryCP server port. + + +
+ +[TRYCP\_SUCCESS\_RESPONSE](./tryorama.trycp_success_response.md) + + + + +Empty success response. + + +
+ +## Type Aliases + + + + + + + + + + + + + + + + + + + +
+ +Type Alias + + + + +Description + + +
+ +[AdminApiResponse](./tryorama.adminapiresponse.md) + + + + +All possible responses from the Admin API. + + +
+ +[AgentsAppsOptions](./tryorama.agentsappsoptions.md) + + + + +An app and an optional agent pub key for each agent. Optionally a network seed to be used for DNA installation. + + +
+ +[AppApiResponse](./tryorama.appapiresponse.md) + + + + +App API Responses. + + +
+ +[CallableCell](./tryorama.callablecell.md) + + + + +Extends an installed cell by a function to call a zome. + + +
+ +[CallZomeFn](./tryorama.callzomefn.md) + + + + +The function for calling a zome from a specific cell. + + +
+ +[CellZomeCallRequest](./tryorama.cellzomecallrequest.md) + + + + +The zome request options adapted to a specific cell. + + +
+ +[ConductorId](./tryorama.conductorid.md) + + + + + + +
+ +[CreateConductorOptions](./tryorama.createconductoroptions.md) + + + + +Options for using the conductor factory. + + +
+ +[IAdminWebsocket](./tryorama.iadminwebsocket.md) + + + + +AdminWebsocket interface for local and TryCP conductors. + + +
+ +[IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) + + + + +AppAgentWebsocket interface for local and TryCP conductors. + + +
+ +[IAppWebsocket](./tryorama.iappwebsocket.md) + + + + +AppWebsocket interface for local and TryCP conductors. + + +
+ +[RequestCallAppInterfaceMessage](./tryorama.requestcallappinterfacemessage.md) + + + + +All possible calls to the App API. + + +
+ +[TryCpApiResponse](./tryorama.trycpapiresponse.md) + + + + +Possible responses from the Admin and App APIs. + + +
+ +[TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md) + + + + +Log level for a TryCP conductor. + + +
+ +[TryCpRequest](./tryorama.trycprequest.md) + + + + +Contains all possible request types. + + +
+ +[TryCpResponseErrorValue](./tryorama.trycpresponseerrorvalue.md) + + + + +Error response values. + + +
+ +[TryCpSuccessResponse](./tryorama.trycpsuccessresponse.md) + + + + +Possible values a for success response from the TryCP server. -| Type Alias | Description | -| --- | --- | -| [AdminApiResponse](./tryorama.adminapiresponse.md) | All possible responses from the Admin API. | -| [AgentsAppsOptions](./tryorama.agentsappsoptions.md) | An app and an optional agent pub key for each agent. Optionally a network seed to be used for DNA installation. | -| [AppApiResponse](./tryorama.appapiresponse.md) | App API Responses. | -| [CallableCell](./tryorama.callablecell.md) | Extends an installed cell by a function to call a zome. | -| [CallZomeFn](./tryorama.callzomefn.md) | The function for calling a zome from a specific cell. | -| [CellZomeCallRequest](./tryorama.cellzomecallrequest.md) | The zome request options adapted to a specific cell. | -| [ConductorId](./tryorama.conductorid.md) | | -| [CreateConductorOptions](./tryorama.createconductoroptions.md) | Options for using the conductor factory. | -| [IAdminWebsocket](./tryorama.iadminwebsocket.md) | AdminWebsocket interface for local and TryCP conductors. | -| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) | AppAgentWebsocket interface for local and TryCP conductors. | -| [IAppWebsocket](./tryorama.iappwebsocket.md) | AppWebsocket interface for local and TryCP conductors. | -| [RequestCallAppInterfaceMessage](./tryorama.requestcallappinterfacemessage.md) | All possible calls to the App API. | -| [TryCpApiResponse](./tryorama.trycpapiresponse.md) | Possible responses from the Admin and App APIs. | -| [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md) | Log level for a TryCP conductor. | -| [TryCpRequest](./tryorama.trycprequest.md) | Contains all possible request types. | -| [TryCpResponseErrorValue](./tryorama.trycpresponseerrorvalue.md) | Error response values. | -| [TryCpSuccessResponse](./tryorama.trycpsuccessresponse.md) | Possible values a for success response from the TryCP server. | +
diff --git a/docs/tryorama.networktype.md b/docs/tryorama.networktype.md index a852d922..ba167ac7 100644 --- a/docs/tryorama.networktype.md +++ b/docs/tryorama.networktype.md @@ -14,8 +14,48 @@ export declare enum NetworkType ## Enumeration Members -| Member | Value | Description | -| --- | --- | --- | -| Mem | "mem" | | -| WebRtc | "webrtc" | | + + + +
+Member + + + + +Value + + + + +Description + + +
+ +Mem + + + + +`"mem"` + + + + + +
+ +WebRtc + + + + +`"webrtc"` + + + + + +
diff --git a/docs/tryorama.pause.md b/docs/tryorama.pause.md index ca03a2a7..560033bd 100644 --- a/docs/tryorama.pause.md +++ b/docs/tryorama.pause.md @@ -14,10 +14,39 @@ pause: (milliseconds: number) => Promise ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| milliseconds | number | The number of milliseconds to wait. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +milliseconds + + + + +number + + + + +The number of milliseconds to wait. + + +
**Returns:** Promise<unknown> diff --git a/docs/tryorama.player.md b/docs/tryorama.player.md index 5a5de42e..9fa3f94b 100644 --- a/docs/tryorama.player.md +++ b/docs/tryorama.player.md @@ -15,7 +15,42 @@ export interface Player extends IPlayer ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [conductor](./tryorama.player.conductor.md) | | [Conductor](./tryorama.conductor.md) | | + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[conductor](./tryorama.player.conductor.md) + + + + + + + +[Conductor](./tryorama.conductor.md) + + + + + +
diff --git a/docs/tryorama.requestadmininterfacemessage.md b/docs/tryorama.requestadmininterfacemessage.md index c6224bb0..a53a3775 100644 --- a/docs/tryorama.requestadmininterfacemessage.md +++ b/docs/tryorama.requestadmininterfacemessage.md @@ -14,8 +14,61 @@ export interface RequestAdminInterfaceMessage ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data?](./tryorama.requestadmininterfacemessage.data.md) | | AddAgentInfoRequest \| AgentInfoRequest \| AttachAppInterfaceRequest \| DeleteCloneCellRequest \| DisableAppRequest \| DumpFullStateRequest \| DumpNetworkStatsRequest \| DumpStateRequest \| EnableAppRequest \| GetDnaDefinitionRequest \| GrantZomeCallCapabilityRequest \| InstallAppRequest \| ListAppsRequest \| RegisterDnaRequest \| StartAppRequest \| StorageInfoRequest \| UninstallAppRequest \| UpdateCoordinatorsRequest | _(Optional)_ | -| [type](./tryorama.requestadmininterfacemessage.type.md) | | "add\_agent\_info" \| "agent\_info" \| "attach\_app\_interface" \| "connect\_app\_interface" \| "delete\_clone\_cell" \| "disable\_app" \| "dump\_full\_state" \| "dump\_network\_stats" \| "dump\_state" \| "enable\_app" \| "generate\_agent\_pub\_key" \| "get\_dna\_definition" \| "grant\_zome\_call\_capability" \| "install\_app" \| "install\_app" \| "list\_apps" \| "list\_app\_interfaces" \| "list\_cell\_ids" \| "list\_dnas" \| "register\_dna" \| "start\_app" \| "storage\_info" \| "uninstall\_app" \| "update\_coordinators" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data?](./tryorama.requestadmininterfacemessage.data.md) + + + + + + + +AddAgentInfoRequest \| AgentInfoRequest \| AttachAppInterfaceRequest \| DeleteCloneCellRequest \| DisableAppRequest \| DumpFullStateRequest \| DumpNetworkStatsRequest \| DumpStateRequest \| EnableAppRequest \| GetDnaDefinitionRequest \| GrantZomeCallCapabilityRequest \| InstallAppRequest \| ListAppsRequest \| RegisterDnaRequest \| StartAppRequest \| StorageInfoRequest \| UninstallAppRequest \| UpdateCoordinatorsRequest + + + + +_(Optional)_ + + +
+ +[type](./tryorama.requestadmininterfacemessage.type.md) + + + + + + + +"add\_agent\_info" \| "agent\_info" \| "attach\_app\_interface" \| "connect\_app\_interface" \| "delete\_clone\_cell" \| "disable\_app" \| "dump\_full\_state" \| "dump\_network\_stats" \| "dump\_state" \| "enable\_app" \| "generate\_agent\_pub\_key" \| "get\_dna\_definition" \| "grant\_zome\_call\_capability" \| "install\_app" \| "install\_app" \| "list\_apps" \| "list\_app\_interfaces" \| "list\_cell\_ids" \| "list\_dnas" \| "register\_dna" \| "start\_app" \| "storage\_info" \| "uninstall\_app" \| "update\_coordinators" + + + + + +
diff --git a/docs/tryorama.requestappinfo.md b/docs/tryorama.requestappinfo.md index 696365e8..5c711f82 100644 --- a/docs/tryorama.requestappinfo.md +++ b/docs/tryorama.requestappinfo.md @@ -14,8 +14,59 @@ export interface RequestAppInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.requestappinfo.data.md) | | { installed\_app\_id: string; } | | -| [type](./tryorama.requestappinfo.type.md) | | "app\_info" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.requestappinfo.data.md) + + + + + + + +{ installed\_app\_id: string; } + + + + + +
+ +[type](./tryorama.requestappinfo.type.md) + + + + + + + +"app\_info" + + + + + +
diff --git a/docs/tryorama.requestcalladmininterface.md b/docs/tryorama.requestcalladmininterface.md index e78f8f5f..5ddc350c 100644 --- a/docs/tryorama.requestcalladmininterface.md +++ b/docs/tryorama.requestcalladmininterface.md @@ -14,9 +14,76 @@ export interface RequestCallAdminInterface ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./tryorama.requestcalladmininterface.id.md) | | [ConductorId](./tryorama.conductorid.md) | | -| [message](./tryorama.requestcalladmininterface.message.md) | | [RequestAdminInterfaceMessage](./tryorama.requestadmininterfacemessage.md) | | -| [type](./tryorama.requestcalladmininterface.type.md) | | "call\_admin\_interface" | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[id](./tryorama.requestcalladmininterface.id.md) + + + + + + + +[ConductorId](./tryorama.conductorid.md) + + + + + +
+ +[message](./tryorama.requestcalladmininterface.message.md) + + + + + + + +[RequestAdminInterfaceMessage](./tryorama.requestadmininterfacemessage.md) + + + + + +
+ +[type](./tryorama.requestcalladmininterface.type.md) + + + + + + + +"call\_admin\_interface" + + + + + +
diff --git a/docs/tryorama.requestcallappinterface.md b/docs/tryorama.requestcallappinterface.md index 9accfb24..75c8a043 100644 --- a/docs/tryorama.requestcallappinterface.md +++ b/docs/tryorama.requestcallappinterface.md @@ -14,9 +14,76 @@ export interface RequestCallAppInterface ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [message](./tryorama.requestcallappinterface.message.md) | | [RequestCallAppInterfaceMessage](./tryorama.requestcallappinterfacemessage.md) | | -| [port](./tryorama.requestcallappinterface.port.md) | | number | | -| [type](./tryorama.requestcallappinterface.type.md) | | "call\_app\_interface" | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[message](./tryorama.requestcallappinterface.message.md) + + + + + + + +[RequestCallAppInterfaceMessage](./tryorama.requestcallappinterfacemessage.md) + + + + + +
+ +[port](./tryorama.requestcallappinterface.port.md) + + + + + + + +number + + + + + +
+ +[type](./tryorama.requestcallappinterface.type.md) + + + + + + + +"call\_app\_interface" + + + + + +
diff --git a/docs/tryorama.requestcallappinterfaceencoded.md b/docs/tryorama.requestcallappinterfaceencoded.md index 5d6960ae..99e85bb6 100644 --- a/docs/tryorama.requestcallappinterfaceencoded.md +++ b/docs/tryorama.requestcallappinterfaceencoded.md @@ -15,7 +15,42 @@ export interface RequestCallAppInterfaceEncoded extends Omit +Property + + + + +Modifiers + + + + +Type + + + + +Description + + + + + +[message](./tryorama.requestcallappinterfaceencoded.message.md) + + + + + + + +Uint8Array + + + + + + + diff --git a/docs/tryorama.requestcallzome.md b/docs/tryorama.requestcallzome.md index 6df5cb7f..646b800c 100644 --- a/docs/tryorama.requestcallzome.md +++ b/docs/tryorama.requestcallzome.md @@ -14,8 +14,59 @@ export interface RequestCallZome ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.requestcallzome.data.md) | | CallZomeRequestSigned | | -| [type](./tryorama.requestcallzome.type.md) | | "call\_zome" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.requestcallzome.data.md) + + + + + + + +CallZomeRequestSigned + + + + + +
+ +[type](./tryorama.requestcallzome.type.md) + + + + + + + +"call\_zome" + + + + + +
diff --git a/docs/tryorama.requestconfigureplayer.md b/docs/tryorama.requestconfigureplayer.md index 5ec67f93..f4bb0fe5 100644 --- a/docs/tryorama.requestconfigureplayer.md +++ b/docs/tryorama.requestconfigureplayer.md @@ -14,9 +14,76 @@ export interface RequestConfigurePlayer ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./tryorama.requestconfigureplayer.id.md) | | [ConductorId](./tryorama.conductorid.md) | | -| [partial\_config](./tryorama.requestconfigureplayer.partial_config.md) | | string | | -| [type](./tryorama.requestconfigureplayer.type.md) | | "configure\_player" | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[id](./tryorama.requestconfigureplayer.id.md) + + + + + + + +[ConductorId](./tryorama.conductorid.md) + + + + + +
+ +[partial\_config](./tryorama.requestconfigureplayer.partial_config.md) + + + + + + + +string + + + + + +
+ +[type](./tryorama.requestconfigureplayer.type.md) + + + + + + + +"configure\_player" + + + + + +
diff --git a/docs/tryorama.requestconnectappinterface.md b/docs/tryorama.requestconnectappinterface.md index a9a26ebf..0a42439d 100644 --- a/docs/tryorama.requestconnectappinterface.md +++ b/docs/tryorama.requestconnectappinterface.md @@ -14,8 +14,59 @@ export interface RequestConnectAppInterface ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [port](./tryorama.requestconnectappinterface.port.md) | | number | | -| [type](./tryorama.requestconnectappinterface.type.md) | | "connect\_app\_interface" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[port](./tryorama.requestconnectappinterface.port.md) + + + + + + + +number + + + + + +
+ +[type](./tryorama.requestconnectappinterface.type.md) + + + + + + + +"connect\_app\_interface" + + + + + +
diff --git a/docs/tryorama.requestcreateclonecell.md b/docs/tryorama.requestcreateclonecell.md index 971a1d65..09b6ecc8 100644 --- a/docs/tryorama.requestcreateclonecell.md +++ b/docs/tryorama.requestcreateclonecell.md @@ -14,8 +14,59 @@ export interface RequestCreateCloneCell ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.requestcreateclonecell.data.md) | | CreateCloneCellRequest | | -| [type](./tryorama.requestcreateclonecell.type.md) | | "create\_clone\_cell" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.requestcreateclonecell.data.md) + + + + + + + +CreateCloneCellRequest + + + + + +
+ +[type](./tryorama.requestcreateclonecell.type.md) + + + + + + + +"create\_clone\_cell" + + + + + +
diff --git a/docs/tryorama.requestdeleteclonecell.md b/docs/tryorama.requestdeleteclonecell.md index 50908d76..ffe91f8b 100644 --- a/docs/tryorama.requestdeleteclonecell.md +++ b/docs/tryorama.requestdeleteclonecell.md @@ -14,8 +14,59 @@ export interface RequestDeleteCloneCell ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.requestdeleteclonecell.data.md) | | DeleteCloneCellRequest | | -| [type](./tryorama.requestdeleteclonecell.type.md) | | "delete\_clone\_cell" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.requestdeleteclonecell.data.md) + + + + + + + +DeleteCloneCellRequest + + + + + +
+ +[type](./tryorama.requestdeleteclonecell.type.md) + + + + + + + +"delete\_clone\_cell" + + + + + +
diff --git a/docs/tryorama.requestdisableclonecell.md b/docs/tryorama.requestdisableclonecell.md index 87a27027..d4a3ce57 100644 --- a/docs/tryorama.requestdisableclonecell.md +++ b/docs/tryorama.requestdisableclonecell.md @@ -14,8 +14,59 @@ export interface RequestDisableCloneCell ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.requestdisableclonecell.data.md) | | DisableCloneCellRequest | | -| [type](./tryorama.requestdisableclonecell.type.md) | | "disable\_clone\_cell" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.requestdisableclonecell.data.md) + + + + + + + +DisableCloneCellRequest + + + + + +
+ +[type](./tryorama.requestdisableclonecell.type.md) + + + + + + + +"disable\_clone\_cell" + + + + + +
diff --git a/docs/tryorama.requestdisconnectappinterface.md b/docs/tryorama.requestdisconnectappinterface.md index f40118ea..cfb5e61c 100644 --- a/docs/tryorama.requestdisconnectappinterface.md +++ b/docs/tryorama.requestdisconnectappinterface.md @@ -14,8 +14,59 @@ export interface RequestDisconnectAppInterface ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [port](./tryorama.requestdisconnectappinterface.port.md) | | number | | -| [type](./tryorama.requestdisconnectappinterface.type.md) | | "disconnect\_app\_interface" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[port](./tryorama.requestdisconnectappinterface.port.md) + + + + + + + +number + + + + + +
+ +[type](./tryorama.requestdisconnectappinterface.type.md) + + + + + + + +"disconnect\_app\_interface" + + + + + +
diff --git a/docs/tryorama.requestdownloaddna.md b/docs/tryorama.requestdownloaddna.md index 5fd1e847..209a974c 100644 --- a/docs/tryorama.requestdownloaddna.md +++ b/docs/tryorama.requestdownloaddna.md @@ -14,8 +14,59 @@ export interface RequestDownloadDna ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [type](./tryorama.requestdownloaddna.type.md) | | "download\_dna" | | -| [url](./tryorama.requestdownloaddna.url.md) | | string | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[type](./tryorama.requestdownloaddna.type.md) + + + + + + + +"download\_dna" + + + + + +
+ +[url](./tryorama.requestdownloaddna.url.md) + + + + + + + +string + + + + + +
diff --git a/docs/tryorama.requestenableclonecell.md b/docs/tryorama.requestenableclonecell.md index 49af9ade..bd72af16 100644 --- a/docs/tryorama.requestenableclonecell.md +++ b/docs/tryorama.requestenableclonecell.md @@ -14,8 +14,59 @@ export interface RequestEnableCloneCell ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.requestenableclonecell.data.md) | | EnableCloneCellRequest | | -| [type](./tryorama.requestenableclonecell.type.md) | | "enable\_clone\_cell" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.requestenableclonecell.data.md) + + + + + + + +EnableCloneCellRequest + + + + + +
+ +[type](./tryorama.requestenableclonecell.type.md) + + + + + + + +"enable\_clone\_cell" + + + + + +
diff --git a/docs/tryorama.requestnetworkinfo.md b/docs/tryorama.requestnetworkinfo.md index 0240c257..6b69f9bf 100644 --- a/docs/tryorama.requestnetworkinfo.md +++ b/docs/tryorama.requestnetworkinfo.md @@ -14,8 +14,59 @@ export interface RequestNetworkInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./tryorama.requestnetworkinfo.data.md) | | NetworkInfoRequest | | -| [type](./tryorama.requestnetworkinfo.type.md) | | "network\_info" | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./tryorama.requestnetworkinfo.data.md) + + + + + + + +NetworkInfoRequest + + + + + +
+ +[type](./tryorama.requestnetworkinfo.type.md) + + + + + + + +"network\_info" + + + + + +
diff --git a/docs/tryorama.requestreset.md b/docs/tryorama.requestreset.md index 62b22233..cb2f8945 100644 --- a/docs/tryorama.requestreset.md +++ b/docs/tryorama.requestreset.md @@ -14,7 +14,42 @@ export interface RequestReset ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [type](./tryorama.requestreset.type.md) | | "reset" | | + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[type](./tryorama.requestreset.type.md) + + + + + + + +"reset" + + + + + +
diff --git a/docs/tryorama.requestsavedna.md b/docs/tryorama.requestsavedna.md index f23d64df..64af53e8 100644 --- a/docs/tryorama.requestsavedna.md +++ b/docs/tryorama.requestsavedna.md @@ -14,9 +14,76 @@ export interface RequestSaveDna ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [content](./tryorama.requestsavedna.content.md) | | Buffer | | -| [id](./tryorama.requestsavedna.id.md) | | string | | -| [type](./tryorama.requestsavedna.type.md) | | "save\_dna" | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[content](./tryorama.requestsavedna.content.md) + + + + + + + +Buffer + + + + + +
+ +[id](./tryorama.requestsavedna.id.md) + + + + + + + +string + + + + + +
+ +[type](./tryorama.requestsavedna.type.md) + + + + + + + +"save\_dna" + + + + + +
diff --git a/docs/tryorama.requestshutdown.md b/docs/tryorama.requestshutdown.md index 7380c9ca..adfef9b5 100644 --- a/docs/tryorama.requestshutdown.md +++ b/docs/tryorama.requestshutdown.md @@ -14,9 +14,78 @@ export interface RequestShutdown ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./tryorama.requestshutdown.id.md) | | [ConductorId](./tryorama.conductorid.md) | | -| [signal?](./tryorama.requestshutdown.signal.md) | | "SIGTERM" \| "SIGKILL" \| "SIGINT" | _(Optional)_ | -| [type](./tryorama.requestshutdown.type.md) | | "shutdown" | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[id](./tryorama.requestshutdown.id.md) + + + + + + + +[ConductorId](./tryorama.conductorid.md) + + + + + +
+ +[signal?](./tryorama.requestshutdown.signal.md) + + + + + + + +"SIGTERM" \| "SIGKILL" \| "SIGINT" + + + + +_(Optional)_ + + +
+ +[type](./tryorama.requestshutdown.type.md) + + + + + + + +"shutdown" + + + + + +
diff --git a/docs/tryorama.requeststartup.md b/docs/tryorama.requeststartup.md index 81e85fe4..afbb46b1 100644 --- a/docs/tryorama.requeststartup.md +++ b/docs/tryorama.requeststartup.md @@ -14,9 +14,78 @@ export interface RequestStartup ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./tryorama.requeststartup.id.md) | | [ConductorId](./tryorama.conductorid.md) | | -| [log\_level?](./tryorama.requeststartup.log_level.md) | | [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md) | _(Optional)_ | -| [type](./tryorama.requeststartup.type.md) | | "startup" | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[id](./tryorama.requeststartup.id.md) + + + + + + + +[ConductorId](./tryorama.conductorid.md) + + + + + +
+ +[log\_level?](./tryorama.requeststartup.log_level.md) + + + + + + + +[TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md) + + + + +_(Optional)_ + + +
+ +[type](./tryorama.requeststartup.type.md) + + + + + + + +"startup" + + + + + +
diff --git a/docs/tryorama.runscenario.md b/docs/tryorama.runscenario.md index 46acc6cc..60f67b9d 100644 --- a/docs/tryorama.runscenario.md +++ b/docs/tryorama.runscenario.md @@ -14,12 +14,71 @@ runScenario: (testScenario: (scenario: Scenario) => Promise, cleanUp?: boo ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| testScenario | (scenario: [Scenario](./tryorama.scenario.md)) => Promise<void> | The test to be run. | -| cleanUp | boolean | _(Optional)_ Whether to delete conductors after running. | -| options | [ScenarioOptions](./tryorama.scenariooptions.md) | _(Optional)_ | + + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +testScenario + + + + +(scenario: [Scenario](./tryorama.scenario.md)) => Promise<void> + + + + +The test to be run. + + +
+ +cleanUp + + + + +boolean + + + + +_(Optional)_ Whether to delete conductors after running. + + +
+ +options + + + + +[ScenarioOptions](./tryorama.scenariooptions.md) + + + + +_(Optional)_ + + +
**Returns:** Promise<void> diff --git a/docs/tryorama.scenario._constructor_.md b/docs/tryorama.scenario._constructor_.md index a72d6009..b0083655 100644 --- a/docs/tryorama.scenario._constructor_.md +++ b/docs/tryorama.scenario._constructor_.md @@ -14,7 +14,36 @@ constructor(options?: ScenarioOptions); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| options | [ScenarioOptions](./tryorama.scenariooptions.md) | _(Optional)_ Timeout for requests to Admin and App API calls. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +[ScenarioOptions](./tryorama.scenariooptions.md) + + + + +_(Optional)_ Timeout for requests to Admin and App API calls. + + +
diff --git a/docs/tryorama.scenario.addplayerswithapps.md b/docs/tryorama.scenario.addplayerswithapps.md index 43448703..0c142b03 100644 --- a/docs/tryorama.scenario.addplayerswithapps.md +++ b/docs/tryorama.scenario.addplayerswithapps.md @@ -17,10 +17,39 @@ addPlayersWithApps(playersApps: Array<{ ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| playersApps | Array<{ appBundleSource: AppBundleSource; options?: [AppOptions](./tryorama.appoptions.md); }> | An array with an app for each player. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +playersApps + + + + +Array<{ appBundleSource: AppBundleSource; options?: [AppOptions](./tryorama.appoptions.md); }> + + + + +An array with an app for each player. + + +
**Returns:** Promise<[Player](./tryorama.player.md)\[\]> diff --git a/docs/tryorama.scenario.addplayerwithapp.md b/docs/tryorama.scenario.addplayerwithapp.md index 6ffddde4..aed75441 100644 --- a/docs/tryorama.scenario.addplayerwithapp.md +++ b/docs/tryorama.scenario.addplayerwithapp.md @@ -14,11 +14,55 @@ addPlayerWithApp(appBundleSource: AppBundleSource, options?: AppOptions): Promis ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| appBundleSource | AppBundleSource | The bundle or path to the bundle. | -| options | [AppOptions](./tryorama.appoptions.md) | _(Optional)_ [AppOptions](./tryorama.appoptions.md). | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +appBundleSource + + + + +AppBundleSource + + + + +The bundle or path to the bundle. + + +
+ +options + + + + +[AppOptions](./tryorama.appoptions.md) + + + + +_(Optional)_ [AppOptions](./tryorama.appoptions.md). + + +
**Returns:** Promise<[Player](./tryorama.player.md)> diff --git a/docs/tryorama.scenario.md b/docs/tryorama.scenario.md index c77d2649..d0db6531 100644 --- a/docs/tryorama.scenario.md +++ b/docs/tryorama.scenario.md @@ -14,28 +14,248 @@ export declare class Scenario ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(options)](./tryorama.scenario._constructor_.md) | | Scenario constructor. | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(options)](./tryorama.scenario._constructor_.md) + + + + + + + +Scenario constructor. + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [bootstrapServerUrl](./tryorama.scenario.bootstrapserverurl.md) | | URL \| undefined | | -| [conductors](./tryorama.scenario.conductors.md) | | [Conductor](./tryorama.conductor.md)\[\] | | -| [networkSeed](./tryorama.scenario.networkseed.md) | | string | | -| [serviceProcess](./tryorama.scenario.serviceprocess.md) | | ChildProcessWithoutNullStreams \| undefined | | -| [signalingServerUrl](./tryorama.scenario.signalingserverurl.md) | | URL \| undefined | | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[bootstrapServerUrl](./tryorama.scenario.bootstrapserverurl.md) + + + + + + + +URL \| undefined + + + + + +
+ +[conductors](./tryorama.scenario.conductors.md) + + + + + + + +[Conductor](./tryorama.conductor.md)\[\] + + + + + +
+ +[networkSeed](./tryorama.scenario.networkseed.md) + + + + + + + +string + + + + + +
+ +[serviceProcess](./tryorama.scenario.serviceprocess.md) + + + + + + + +ChildProcessWithoutNullStreams \| undefined + + + + + +
+ +[signalingServerUrl](./tryorama.scenario.signalingserverurl.md) + + + + + + + +URL \| undefined + + + + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [addConductor()](./tryorama.scenario.addconductor.md) | | Create and add a conductor to the scenario. | -| [addPlayersWithApps(playersApps)](./tryorama.scenario.addplayerswithapps.md) | | Create and add multiple players to the scenario, with an app installed for each player. | -| [addPlayerWithApp(appBundleSource, options)](./tryorama.scenario.addplayerwithapp.md) | | Create and add a single player with an app installed to the scenario. | -| [cleanUp()](./tryorama.scenario.cleanup.md) | | Shut down and delete all conductors in the scenario. | -| [shareAllAgents()](./tryorama.scenario.shareallagents.md) | | Register all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. | -| [shutDown()](./tryorama.scenario.shutdown.md) | | Shut down all conductors in the scenario. | + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[addConductor()](./tryorama.scenario.addconductor.md) + + + + + + + +Create and add a conductor to the scenario. + + +
+ +[addPlayersWithApps(playersApps)](./tryorama.scenario.addplayerswithapps.md) + + + + + + + +Create and add multiple players to the scenario, with an app installed for each player. + + +
+ +[addPlayerWithApp(appBundleSource, options)](./tryorama.scenario.addplayerwithapp.md) + + + + + + + +Create and add a single player with an app installed to the scenario. + + +
+ +[cleanUp()](./tryorama.scenario.cleanup.md) + + + + + + + +Shut down and delete all conductors in the scenario. + + +
+ +[shareAllAgents()](./tryorama.scenario.shareallagents.md) + + + + + + + +Register all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. + + +
+ +[shutDown()](./tryorama.scenario.shutdown.md) + + + + + + + +Shut down all conductors in the scenario. + +
diff --git a/docs/tryorama.scenariooptions.md b/docs/tryorama.scenariooptions.md index 5af22b95..84da31c5 100644 --- a/docs/tryorama.scenariooptions.md +++ b/docs/tryorama.scenariooptions.md @@ -14,7 +14,44 @@ export interface ScenarioOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [timeout?](./tryorama.scenariooptions.timeout.md) | | number | _(Optional)_ | + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[timeout?](./tryorama.scenariooptions.timeout.md) + + + + + + + +number + + + + +_(Optional)_ + + +
diff --git a/docs/tryorama.stoplocalservices.md b/docs/tryorama.stoplocalservices.md index 813726fb..668b69a8 100644 --- a/docs/tryorama.stoplocalservices.md +++ b/docs/tryorama.stoplocalservices.md @@ -14,10 +14,37 @@ stopLocalServices: (localServicesProcess: ChildProcessWithoutNullStreams) => Pro ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| localServicesProcess | ChildProcessWithoutNullStreams | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +localServicesProcess + + + + +ChildProcessWithoutNullStreams + + + + + +
**Returns:** Promise<number \| null> \| null diff --git a/docs/tryorama.trycpclient.addconductor.md b/docs/tryorama.trycpclient.addconductor.md index b40c27ff..3e980176 100644 --- a/docs/tryorama.trycpclient.addconductor.md +++ b/docs/tryorama.trycpclient.addconductor.md @@ -14,10 +14,39 @@ addConductor(partialConfig?: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| partialConfig | string | _(Optional)_ Conductor configuration (optional). | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +partialConfig + + + + +string + + + + +_(Optional)_ Conductor configuration (optional). + + +
**Returns:** Promise<[TryCpConductor](./tryorama.trycpconductor.md)> diff --git a/docs/tryorama.trycpclient.call.md b/docs/tryorama.trycpclient.call.md index a1506827..2ad44ded 100644 --- a/docs/tryorama.trycpclient.call.md +++ b/docs/tryorama.trycpclient.call.md @@ -14,10 +14,39 @@ call(request: TryCpRequest): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| request | [TryCpRequest](./tryorama.trycprequest.md) | [TryCpRequest](./tryorama.trycprequest.md) | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +request + + + + +[TryCpRequest](./tryorama.trycprequest.md) + + + + +[TryCpRequest](./tryorama.trycprequest.md) + + +
**Returns:** Promise<[TryCpSuccessResponse](./tryorama.trycpsuccessresponse.md)> diff --git a/docs/tryorama.trycpclient.create.md b/docs/tryorama.trycpclient.create.md index 1ef0eaf6..2bff3474 100644 --- a/docs/tryorama.trycpclient.create.md +++ b/docs/tryorama.trycpclient.create.md @@ -14,11 +14,55 @@ static create(serverUrl: URL, timeout?: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| serverUrl | URL | The URL of the TryCP server. | -| timeout | number | _(Optional)_ | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +serverUrl + + + + +URL + + + + +The URL of the TryCP server. + + +
+ +timeout + + + + +number + + + + +_(Optional)_ + + +
**Returns:** Promise<[TryCpClient](./tryorama.trycpclient.md)> diff --git a/docs/tryorama.trycpclient.md b/docs/tryorama.trycpclient.md index 9b2ceaa7..3a6eac05 100644 --- a/docs/tryorama.trycpclient.md +++ b/docs/tryorama.trycpclient.md @@ -16,24 +16,234 @@ export declare class TryCpClient ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [bootstrapServerUrl](./tryorama.trycpclient.bootstrapserverurl.md) | | URL \| undefined | | -| [conductors](./tryorama.trycpclient.conductors.md) | | [TryCpConductor](./tryorama.trycpconductor.md)\[\] | | -| [signalingServerUrl](./tryorama.trycpclient.signalingserverurl.md) | | URL \| undefined | | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[bootstrapServerUrl](./tryorama.trycpclient.bootstrapserverurl.md) + + + + + + + +URL \| undefined + + + + + +
+ +[conductors](./tryorama.trycpclient.conductors.md) + + + + + + + +[TryCpConductor](./tryorama.trycpconductor.md)\[\] + + + + + +
+ +[signalingServerUrl](./tryorama.trycpclient.signalingserverurl.md) + + + + + + + +URL \| undefined + + + + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [addConductor(partialConfig)](./tryorama.trycpclient.addconductor.md) | | Create and add a conductor to the client. | -| [call(request)](./tryorama.trycpclient.call.md) | | Send a call to the TryCP server. | -| [cleanAllConductors()](./tryorama.trycpclient.cleanallconductors.md) | | Run the reset command on the TryCP server to delete all conductor data. | -| [cleanUp()](./tryorama.trycpclient.cleanup.md) | | Shut down all registered conductors and delete them, and close the client connection. | -| [close()](./tryorama.trycpclient.close.md) | | Closes the client connection. | -| [create(serverUrl, timeout)](./tryorama.trycpclient.create.md) | static | Create a client connection to a running TryCP server. | -| [ping(data)](./tryorama.trycpclient.ping.md) | | Send a ping with data. | -| [setSignalHandler(port, signalHandler)](./tryorama.trycpclient.setsignalhandler.md) | | | -| [shutDownConductors()](./tryorama.trycpclient.shutdownconductors.md) | | Shut down all conductors on the connected TryCP server and disconnect their app interfaces. | -| [unsetSignalHandler(port)](./tryorama.trycpclient.unsetsignalhandler.md) | | | + + + + + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[addConductor(partialConfig)](./tryorama.trycpclient.addconductor.md) + + + + + + + +Create and add a conductor to the client. + + +
+ +[call(request)](./tryorama.trycpclient.call.md) + + + + + + + +Send a call to the TryCP server. + + +
+ +[cleanAllConductors()](./tryorama.trycpclient.cleanallconductors.md) + + + + + + + +Run the `reset` command on the TryCP server to delete all conductor data. + + +
+ +[cleanUp()](./tryorama.trycpclient.cleanup.md) + + + + + + + +Shut down all registered conductors and delete them, and close the client connection. + + +
+ +[close()](./tryorama.trycpclient.close.md) + + + + + + + +Closes the client connection. + + +
+ +[create(serverUrl, timeout)](./tryorama.trycpclient.create.md) + + + + +`static` + + + + +Create a client connection to a running TryCP server. + + +
+ +[ping(data)](./tryorama.trycpclient.ping.md) + + + + + + + +Send a ping with data. + + +
+ +[setSignalHandler(port, signalHandler)](./tryorama.trycpclient.setsignalhandler.md) + + + + + + + + +
+ +[shutDownConductors()](./tryorama.trycpclient.shutdownconductors.md) + + + + + + + +Shut down all conductors on the connected TryCP server and disconnect their app interfaces. + + +
+ +[unsetSignalHandler(port)](./tryorama.trycpclient.unsetsignalhandler.md) + + + + + + + +
diff --git a/docs/tryorama.trycpclient.ping.md b/docs/tryorama.trycpclient.ping.md index 867c70ac..0be6b9c1 100644 --- a/docs/tryorama.trycpclient.ping.md +++ b/docs/tryorama.trycpclient.ping.md @@ -14,10 +14,39 @@ ping(data: unknown): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| data | unknown | Data to send and receive with the ping-pong. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +data + + + + +unknown + + + + +Data to send and receive with the ping-pong. + + +
**Returns:** Promise<Buffer> diff --git a/docs/tryorama.trycpclient.setsignalhandler.md b/docs/tryorama.trycpclient.setsignalhandler.md index 82fef969..d4514ffa 100644 --- a/docs/tryorama.trycpclient.setsignalhandler.md +++ b/docs/tryorama.trycpclient.setsignalhandler.md @@ -12,11 +12,53 @@ setSignalHandler(port: number, signalHandler?: AppSignalCb): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | | -| signalHandler | AppSignalCb | _(Optional)_ | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + + +
+ +signalHandler + + + + +AppSignalCb + + + + +_(Optional)_ + + +
**Returns:** void diff --git a/docs/tryorama.trycpclient.unsetsignalhandler.md b/docs/tryorama.trycpclient.unsetsignalhandler.md index bf8ffb02..cb576723 100644 --- a/docs/tryorama.trycpclient.unsetsignalhandler.md +++ b/docs/tryorama.trycpclient.unsetsignalhandler.md @@ -12,10 +12,37 @@ unsetSignalHandler(port: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + + +
**Returns:** void diff --git a/docs/tryorama.trycpconductor._constructor_.md b/docs/tryorama.trycpconductor._constructor_.md index 56fad143..195885d6 100644 --- a/docs/tryorama.trycpconductor._constructor_.md +++ b/docs/tryorama.trycpconductor._constructor_.md @@ -14,8 +14,50 @@ constructor(tryCpClient: TryCpClient, id?: ConductorId); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| tryCpClient | [TryCpClient](./tryorama.trycpclient.md) | | -| id | [ConductorId](./tryorama.conductorid.md) | _(Optional)_ | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +tryCpClient + + + + +[TryCpClient](./tryorama.trycpclient.md) + + + + + +
+ +id + + + + +[ConductorId](./tryorama.conductorid.md) + + + + +_(Optional)_ + + +
diff --git a/docs/tryorama.trycpconductor.configure.md b/docs/tryorama.trycpconductor.configure.md index 96058753..e0e634c7 100644 --- a/docs/tryorama.trycpconductor.configure.md +++ b/docs/tryorama.trycpconductor.configure.md @@ -14,10 +14,39 @@ configure(partialConfig?: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| partialConfig | string | _(Optional)_ The configuration to add to the default configuration. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +partialConfig + + + + +string + + + + +_(Optional)_ The configuration to add to the default configuration. + + +
**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.connectappagentws.md b/docs/tryorama.trycpconductor.connectappagentws.md index e1a3aa0c..5bd8b59d 100644 --- a/docs/tryorama.trycpconductor.connectappagentws.md +++ b/docs/tryorama.trycpconductor.connectappagentws.md @@ -19,11 +19,51 @@ connectAppAgentWs(port: number, appId: InstalledAppId): Promise<{ ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | | -| appId | InstalledAppId | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + + +
+ +appId + + + + +InstalledAppId + + + + + +
**Returns:** Promise<{ appInfo: (request: AppInfoRequest) => Promise<import("@holochain/client").AppInfoResponse>; callZome: <T>(request: CallZomeRequest \| CallZomeRequestSigned) => Promise<T>; createCloneCell: (request: CreateCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; enableCloneCell: (request: DisableCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; disableCloneCell: (request: DisableCloneCellRequest) => Promise<void>; networkInfo: (request: NetworkInfoRequest) => Promise<import("@holochain/client").NetworkInfoResponse>; }> diff --git a/docs/tryorama.trycpconductor.connectappinterface.md b/docs/tryorama.trycpconductor.connectappinterface.md index cf160ebb..77750f96 100644 --- a/docs/tryorama.trycpconductor.connectappinterface.md +++ b/docs/tryorama.trycpconductor.connectappinterface.md @@ -14,10 +14,39 @@ connectAppInterface(port: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | The port to attach the app interface to. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + +The port to attach the app interface to. + + +
**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.connectappws.md b/docs/tryorama.trycpconductor.connectappws.md index fa25abb5..e9a3f6cf 100644 --- a/docs/tryorama.trycpconductor.connectappws.md +++ b/docs/tryorama.trycpconductor.connectappws.md @@ -21,10 +21,37 @@ connectAppWs(port: number): Promise<{ ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + + +
**Returns:** Promise<{ appInfo: (request: AppInfoRequest) => Promise<import("@holochain/client").AppInfoResponse>; callZome: <T>(request: CallZomeRequest \| CallZomeRequestSigned) => Promise<T>; createCloneCell: (request: CreateCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; enableCloneCell: (request: EnableCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; disableCloneCell: (request: DisableCloneCellRequest) => Promise<void>; networkInfo: (request: NetworkInfoRequest) => Promise<import("@holochain/client").NetworkInfoResponse>; }> diff --git a/docs/tryorama.trycpconductor.disconnectappinterface.md b/docs/tryorama.trycpconductor.disconnectappinterface.md index 4097ae33..72b9baab 100644 --- a/docs/tryorama.trycpconductor.disconnectappinterface.md +++ b/docs/tryorama.trycpconductor.disconnectappinterface.md @@ -14,10 +14,39 @@ disconnectAppInterface(port: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | The port of the app interface to disconnect. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + +The port of the app interface to disconnect. + + +
**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.downloaddna.md b/docs/tryorama.trycpconductor.downloaddna.md index 489b7494..21d75f4d 100644 --- a/docs/tryorama.trycpconductor.downloaddna.md +++ b/docs/tryorama.trycpconductor.downloaddna.md @@ -14,10 +14,37 @@ downloadDna(url: URL): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| url | URL | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +URL + + + + + +
**Returns:** Promise<string> diff --git a/docs/tryorama.trycpconductor.installagentsapps.md b/docs/tryorama.trycpconductor.installagentsapps.md index 884bfdae..44fbcc3b 100644 --- a/docs/tryorama.trycpconductor.installagentsapps.md +++ b/docs/tryorama.trycpconductor.installagentsapps.md @@ -14,10 +14,39 @@ installAgentsApps(options: AgentsAppsOptions): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| options | [AgentsAppsOptions](./tryorama.agentsappsoptions.md) | Apps to install for each agent, with agent pub keys etc. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +[AgentsAppsOptions](./tryorama.agentsappsoptions.md) + + + + +Apps to install for each agent, with agent pub keys etc. + + +
**Returns:** Promise<AppInfo\[\]> diff --git a/docs/tryorama.trycpconductor.installapp.md b/docs/tryorama.trycpconductor.installapp.md index d53bc61d..15b1fa34 100644 --- a/docs/tryorama.trycpconductor.installapp.md +++ b/docs/tryorama.trycpconductor.installapp.md @@ -14,11 +14,55 @@ installApp(appBundleSource: AppBundleSource, options?: AppOptions): Promise +Parameter + + + + +Type + + + + +Description + + + + + +appBundleSource + + + + +AppBundleSource + + + + +The bundle or path to the bundle. + + + + + +options + + + + +[AppOptions](./tryorama.appoptions.md) + + + + +_(Optional)_ [AppOptions](./tryorama.appoptions.md) for the hApp bundle (optional). + + + + **Returns:** Promise<AppInfo> diff --git a/docs/tryorama.trycpconductor.md b/docs/tryorama.trycpconductor.md index 12541d56..5f76201b 100644 --- a/docs/tryorama.trycpconductor.md +++ b/docs/tryorama.trycpconductor.md @@ -15,34 +15,325 @@ export declare class TryCpConductor implements IConductor ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(tryCpClient, id)](./tryorama.trycpconductor._constructor_.md) | | Constructs a new instance of the TryCpConductor class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(tryCpClient, id)](./tryorama.trycpconductor._constructor_.md) + + + + + + + +Constructs a new instance of the `TryCpConductor` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./tryorama.trycpconductor.id.md) | readonly | string | | -| [tryCpClient](./tryorama.trycpconductor.trycpclient.md) | readonly | [TryCpClient](./tryorama.trycpclient.md) | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[id](./tryorama.trycpconductor.id.md) + + + + +`readonly` + + + + +string + + + + + +
+ +[tryCpClient](./tryorama.trycpconductor.trycpclient.md) + + + + +`readonly` + + + + +[TryCpClient](./tryorama.trycpclient.md) + + + + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [adminWs()](./tryorama.trycpconductor.adminws.md) | | Get all [Admin API methods](https://github.com/holochain/holochain-client-js/blob/develop/docs/API_adminwebsocket.md) of the Holochain client. | -| [configure(partialConfig)](./tryorama.trycpconductor.configure.md) | | Create conductor configuration. | -| [connectAppAgentWs(port, appId)](./tryorama.trycpconductor.connectappagentws.md) | | | -| [connectAppInterface(port)](./tryorama.trycpconductor.connectappinterface.md) | | Connect a web socket to the App API. | -| [connectAppWs(port)](./tryorama.trycpconductor.connectappws.md) | | Get all [App API methods](https://github.com/holochain/holochain-client-js/blob/develop/docs/API_appwebsocket.md) of the Holochain client. | -| [disconnectAppInterface(port)](./tryorama.trycpconductor.disconnectappinterface.md) | | Disconnect a web socket from the App API. | -| [disconnectClient()](./tryorama.trycpconductor.disconnectclient.md) | | Disconnect the TryCP client from the TryCP server. | -| [downloadDna(url)](./tryorama.trycpconductor.downloaddna.md) | | Download a DNA from a URL to the server's file system. | -| [installAgentsApps(options)](./tryorama.trycpconductor.installagentsapps.md) | | Install a hApp bundle into the conductor. | -| [installApp(appBundleSource, options)](./tryorama.trycpconductor.installapp.md) | | Install a hApp bundle into the conductor. | -| [off(port)](./tryorama.trycpconductor.off.md) | | Detach the registered signal handler. | -| [on(port, signalHandler)](./tryorama.trycpconductor.on.md) | | Attach a signal handler. | -| [saveDna(dnaContent)](./tryorama.trycpconductor.savedna.md) | | Upload a DNA file from the local file system to the server. | -| [shutDown()](./tryorama.trycpconductor.shutdown.md) | | Shut down the conductor. | -| [startUp(options)](./tryorama.trycpconductor.startup.md) | | Start a configured conductor. | + + + + + + + + + + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[adminWs()](./tryorama.trycpconductor.adminws.md) + + + + + + + +Get all [Admin API methods](https://github.com/holochain/holochain-client-js/blob/develop/docs/API_adminwebsocket.md) of the Holochain client. + + +
+ +[configure(partialConfig)](./tryorama.trycpconductor.configure.md) + + + + + + + +Create conductor configuration. + + +
+ +[connectAppAgentWs(port, appId)](./tryorama.trycpconductor.connectappagentws.md) + + + + + + + + +
+ +[connectAppInterface(port)](./tryorama.trycpconductor.connectappinterface.md) + + + + + + + +Connect a web socket to the App API. + + +
+ +[connectAppWs(port)](./tryorama.trycpconductor.connectappws.md) + + + + + + + +Get all [App API methods](https://github.com/holochain/holochain-client-js/blob/develop/docs/API_appwebsocket.md) of the Holochain client. + + +
+ +[disconnectAppInterface(port)](./tryorama.trycpconductor.disconnectappinterface.md) + + + + + + + +Disconnect a web socket from the App API. + + +
+ +[disconnectClient()](./tryorama.trycpconductor.disconnectclient.md) + + + + + + + +Disconnect the TryCP client from the TryCP server. + + +
+ +[downloadDna(url)](./tryorama.trycpconductor.downloaddna.md) + + + + + + + +Download a DNA from a URL to the server's file system. + + +
+ +[installAgentsApps(options)](./tryorama.trycpconductor.installagentsapps.md) + + + + + + + +Install a hApp bundle into the conductor. + + +
+ +[installApp(appBundleSource, options)](./tryorama.trycpconductor.installapp.md) + + + + + + + +Install a hApp bundle into the conductor. + + +
+ +[off(port)](./tryorama.trycpconductor.off.md) + + + + + + + +Detach the registered signal handler. + + +
+ +[on(port, signalHandler)](./tryorama.trycpconductor.on.md) + + + + + + + +Attach a signal handler. + + +
+ +[saveDna(dnaContent)](./tryorama.trycpconductor.savedna.md) + + + + + + + +Upload a DNA file from the local file system to the server. + + +
+ +[shutDown()](./tryorama.trycpconductor.shutdown.md) + + + + + + + +Shut down the conductor. + + +
+ +[startUp(options)](./tryorama.trycpconductor.startup.md) + + + + + + + +Start a configured conductor. + +
diff --git a/docs/tryorama.trycpconductor.off.md b/docs/tryorama.trycpconductor.off.md index 0ab5291d..85cce2a8 100644 --- a/docs/tryorama.trycpconductor.off.md +++ b/docs/tryorama.trycpconductor.off.md @@ -14,10 +14,37 @@ off(port: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + + +
**Returns:** void diff --git a/docs/tryorama.trycpconductor.on.md b/docs/tryorama.trycpconductor.on.md index 92cff933..8b6c9e5c 100644 --- a/docs/tryorama.trycpconductor.on.md +++ b/docs/tryorama.trycpconductor.on.md @@ -14,11 +14,55 @@ on(port: number, signalHandler: AppSignalCb): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | The port of the app interface. | -| signalHandler | AppSignalCb | The signal handler to register. | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + +The port of the app interface. + + +
+ +signalHandler + + + + +AppSignalCb + + + + +The signal handler to register. + + +
**Returns:** void diff --git a/docs/tryorama.trycpconductor.savedna.md b/docs/tryorama.trycpconductor.savedna.md index 98282488..6032c6fe 100644 --- a/docs/tryorama.trycpconductor.savedna.md +++ b/docs/tryorama.trycpconductor.savedna.md @@ -14,10 +14,39 @@ saveDna(dnaContent: Buffer): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| dnaContent | Buffer | The DNA as binary content. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +dnaContent + + + + +Buffer + + + + +The DNA as binary content. + + +
**Returns:** Promise<string> diff --git a/docs/tryorama.trycpconductor.startup.md b/docs/tryorama.trycpconductor.startup.md index 28c20c53..47e616f5 100644 --- a/docs/tryorama.trycpconductor.startup.md +++ b/docs/tryorama.trycpconductor.startup.md @@ -16,10 +16,39 @@ startUp(options?: { ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| options | { logLevel?: [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md); } | _(Optional)_ Log level of the conductor. Defaults to "info". | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +{ logLevel?: [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md); } + + + + +_(Optional)_ Log level of the conductor. Defaults to "info". + + +
**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductoroptions.md b/docs/tryorama.trycpconductoroptions.md index 42ccaaf5..7983e6ef 100644 --- a/docs/tryorama.trycpconductoroptions.md +++ b/docs/tryorama.trycpconductoroptions.md @@ -13,10 +13,105 @@ export interface TryCpConductorOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id?](./tryorama.trycpconductoroptions.id.md) | | [ConductorId](./tryorama.conductorid.md) | _(Optional)_ Identifier for the conductor (optional). | -| [logLevel?](./tryorama.trycpconductoroptions.loglevel.md) | | [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md) |

_(Optional)_ Log level of the conductor (optional).

default: "info"

| -| [partialConfig?](./tryorama.trycpconductoroptions.partialconfig.md) | | string | _(Optional)_ Configuration for the conductor (optional). | -| [startup?](./tryorama.trycpconductoroptions.startup.md) | | boolean |

_(Optional)_ Start up conductor after creation.

default: true

| + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[id?](./tryorama.trycpconductoroptions.id.md) + + + + + + + +[ConductorId](./tryorama.conductorid.md) + + + + +_(Optional)_ Identifier for the conductor (optional). + + +
+ +[logLevel?](./tryorama.trycpconductoroptions.loglevel.md) + + + + + + + +[TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md) + + + + +_(Optional)_ Log level of the conductor (optional). + +default: "info" + + +
+ +[partialConfig?](./tryorama.trycpconductoroptions.partialconfig.md) + + + + + + + +string + + + + +_(Optional)_ Configuration for the conductor (optional). + + +
+ +[startup?](./tryorama.trycpconductoroptions.startup.md) + + + + + + + +boolean + + + + +_(Optional)_ Start up conductor after creation. + +default: true + + +
diff --git a/docs/tryorama.trycpplayer.md b/docs/tryorama.trycpplayer.md index 73d03232..43299d57 100644 --- a/docs/tryorama.trycpplayer.md +++ b/docs/tryorama.trycpplayer.md @@ -15,7 +15,42 @@ export interface TryCpPlayer extends IPlayer ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [conductor](./tryorama.trycpplayer.conductor.md) | | [TryCpConductor](./tryorama.trycpconductor.md) | | + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[conductor](./tryorama.trycpplayer.conductor.md) + + + + + + + +[TryCpConductor](./tryorama.trycpconductor.md) + + + + + +
diff --git a/docs/tryorama.trycpscenario.addclient.md b/docs/tryorama.trycpscenario.addclient.md index adc15af5..19925697 100644 --- a/docs/tryorama.trycpscenario.addclient.md +++ b/docs/tryorama.trycpscenario.addclient.md @@ -14,11 +14,55 @@ addClient(serverUrl: URL, timeout?: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| serverUrl | URL | The TryCP server URL to connect to. | -| timeout | number | _(Optional)_ An optional timeout for the web socket connection. | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +serverUrl + + + + +URL + + + + +The TryCP server URL to connect to. + + +
+ +timeout + + + + +number + + + + +_(Optional)_ An optional timeout for the web socket connection. + + +
**Returns:** Promise<[TryCpClient](./tryorama.trycpclient.md)> diff --git a/docs/tryorama.trycpscenario.addclientsplayers.md b/docs/tryorama.trycpscenario.addclientsplayers.md index bbd2130b..9f8cdabc 100644 --- a/docs/tryorama.trycpscenario.addclientsplayers.md +++ b/docs/tryorama.trycpscenario.addclientsplayers.md @@ -16,11 +16,55 @@ addClientsPlayers(serverUrls: URL[], options: ClientsPlayersOptions): Promise +Parameter + + + + +Type + + + + +Description + + + + + +serverUrls + + + + +URL\[\] + + + + +The TryCP server URLs to connect to. + + + + + +options + + + + +[ClientsPlayersOptions](./tryorama.clientsplayersoptions.md) + + + + +[ClientsPlayersOptions](./tryorama.clientsplayersoptions.md) + + + + **Returns:** Promise<[ClientPlayers](./tryorama.clientplayers.md)\[\]> diff --git a/docs/tryorama.trycpscenario.addplayerswithapps.md b/docs/tryorama.trycpscenario.addplayerswithapps.md index 6c39324e..877a75e9 100644 --- a/docs/tryorama.trycpscenario.addplayerswithapps.md +++ b/docs/tryorama.trycpscenario.addplayerswithapps.md @@ -17,11 +17,55 @@ addPlayersWithApps(tryCpClient: TryCpClient, playersApps: Array<{ ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| tryCpClient | [TryCpClient](./tryorama.trycpclient.md) | The client connection to the TryCP server on which to create the player. | -| playersApps | Array<{ appBundleSource: AppBundleSource; options?: [AppOptions](./tryorama.appoptions.md); }> | An array with an app for each player. | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +tryCpClient + + + + +[TryCpClient](./tryorama.trycpclient.md) + + + + +The client connection to the TryCP server on which to create the player. + + +
+ +playersApps + + + + +Array<{ appBundleSource: AppBundleSource; options?: [AppOptions](./tryorama.appoptions.md); }> + + + + +An array with an app for each player. + + +
**Returns:** Promise<[TryCpPlayer](./tryorama.trycpplayer.md)\[\]> diff --git a/docs/tryorama.trycpscenario.addplayerwithapp.md b/docs/tryorama.trycpscenario.addplayerwithapp.md index f1cdb3bd..2ed3b6b7 100644 --- a/docs/tryorama.trycpscenario.addplayerwithapp.md +++ b/docs/tryorama.trycpscenario.addplayerwithapp.md @@ -14,12 +14,71 @@ addPlayerWithApp(tryCpClient: TryCpClient, appBundleSource: AppBundleSource, opt ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| tryCpClient | [TryCpClient](./tryorama.trycpclient.md) | The client connection to the TryCP server on which to create the player. | -| appBundleSource | AppBundleSource | The bundle or path of the app. | -| options | [AppOptions](./tryorama.appoptions.md) | _(Optional)_ [AppOptions](./tryorama.appoptions.md) like agent pub key etc. | + + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +tryCpClient + + + + +[TryCpClient](./tryorama.trycpclient.md) + + + + +The client connection to the TryCP server on which to create the player. + + +
+ +appBundleSource + + + + +AppBundleSource + + + + +The bundle or path of the app. + + +
+ +options + + + + +[AppOptions](./tryorama.appoptions.md) + + + + +_(Optional)_ [AppOptions](./tryorama.appoptions.md) like agent pub key etc. + + +
**Returns:** Promise<[TryCpPlayer](./tryorama.trycpplayer.md)> diff --git a/docs/tryorama.trycpscenario.md b/docs/tryorama.trycpscenario.md index 6250b6d0..c594f221 100644 --- a/docs/tryorama.trycpscenario.md +++ b/docs/tryorama.trycpscenario.md @@ -16,29 +16,264 @@ export declare class TryCpScenario ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)()](./tryorama.trycpscenario._constructor_.md) | | Constructs a new instance of the TryCpScenario class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)()](./tryorama.trycpscenario._constructor_.md) + + + + + + + +Constructs a new instance of the `TryCpScenario` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [bootstrapServerUrl](./tryorama.trycpscenario.bootstrapserverurl.md) | | URL \| undefined | | -| [clients](./tryorama.trycpscenario.clients.md) | | [TryCpClient](./tryorama.trycpclient.md)\[\] | | -| [network\_seed](./tryorama.trycpscenario.network_seed.md) | | string | | -| [servicesProcess](./tryorama.trycpscenario.servicesprocess.md) | | ChildProcessWithoutNullStreams \| undefined | | -| [signalingServerUrl](./tryorama.trycpscenario.signalingserverurl.md) | | URL \| undefined | | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[bootstrapServerUrl](./tryorama.trycpscenario.bootstrapserverurl.md) + + + + + + + +URL \| undefined + + + + + +
+ +[clients](./tryorama.trycpscenario.clients.md) + + + + + + + +[TryCpClient](./tryorama.trycpclient.md)\[\] + + + + + +
+ +[network\_seed](./tryorama.trycpscenario.network_seed.md) + + + + + + + +string + + + + + +
+ +[servicesProcess](./tryorama.trycpscenario.servicesprocess.md) + + + + + + + +ChildProcessWithoutNullStreams \| undefined + + + + + +
+ +[signalingServerUrl](./tryorama.trycpscenario.signalingserverurl.md) + + + + + + + +URL \| undefined + + + + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [addClient(serverUrl, timeout)](./tryorama.trycpscenario.addclient.md) | | Creates a TryCP client connection and add it to the scenario. | -| [addClientsPlayers(serverUrls, options)](./tryorama.trycpscenario.addclientsplayers.md) | |

Creates client connections for all passed in URLs and, depending on the options, creates multiple players with apps. Adds all clients to the scenario.

If no number of agents per conductor is specified, it defaults to 1.

| -| [addPlayersWithApps(tryCpClient, playersApps)](./tryorama.trycpscenario.addplayerswithapps.md) | | Creates and adds multiple players with an installed app to the scenario. | -| [addPlayerWithApp(tryCpClient, appBundleSource, options)](./tryorama.trycpscenario.addplayerwithapp.md) | | Creates and adds a single player with an installed app to the scenario, | -| [cleanUp()](./tryorama.trycpscenario.cleanup.md) | | Shut down and delete all conductors and close all client connections in the scenario. | -| [shareAllAgents()](./tryorama.trycpscenario.shareallagents.md) | | Registers all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. | -| [shutDown()](./tryorama.trycpscenario.shutdown.md) | | Shut down all conductors of all clients in the scenario. | + + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[addClient(serverUrl, timeout)](./tryorama.trycpscenario.addclient.md) + + + + + + + +Creates a TryCP client connection and add it to the scenario. + + +
+ +[addClientsPlayers(serverUrls, options)](./tryorama.trycpscenario.addclientsplayers.md) + + + + + + + +Creates client connections for all passed in URLs and, depending on the options, creates multiple players with apps. Adds all clients to the scenario. + +If no number of agents per conductor is specified, it defaults to 1. + + +
+ +[addPlayersWithApps(tryCpClient, playersApps)](./tryorama.trycpscenario.addplayerswithapps.md) + + + + + + + +Creates and adds multiple players with an installed app to the scenario. + + +
+ +[addPlayerWithApp(tryCpClient, appBundleSource, options)](./tryorama.trycpscenario.addplayerwithapp.md) + + + + + + + +Creates and adds a single player with an installed app to the scenario, + + +
+ +[cleanUp()](./tryorama.trycpscenario.cleanup.md) + + + + + + + +Shut down and delete all conductors and close all client connections in the scenario. + + +
+ +[shareAllAgents()](./tryorama.trycpscenario.shareallagents.md) + + + + + + + +Registers all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. + + +
+ +[shutDown()](./tryorama.trycpscenario.shutdown.md) + + + + + + + +Shut down all conductors of all clients in the scenario. + +
diff --git a/docs/tryorama.trycpserver.md b/docs/tryorama.trycpserver.md index 24650fc2..5800cbc9 100644 --- a/docs/tryorama.trycpserver.md +++ b/docs/tryorama.trycpserver.md @@ -14,8 +14,50 @@ export declare class TryCpServer ## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [start(port)](./tryorama.trycpserver.start.md) | static | Builds and starts a local TryCP server on the specified port. | -| [stop()](./tryorama.trycpserver.stop.md) | | Stops the server instance by killing the server process. | + + + +
+Method + + + + +Modifiers + + + + +Description + + +
+ +[start(port)](./tryorama.trycpserver.start.md) + + + + +`static` + + + + +Builds and starts a local TryCP server on the specified port. + + +
+ +[stop()](./tryorama.trycpserver.stop.md) + + + + + + + +Stops the server instance by killing the server process. + + +
diff --git a/docs/tryorama.trycpserver.start.md b/docs/tryorama.trycpserver.start.md index 855cdbf8..0ca1f920 100644 --- a/docs/tryorama.trycpserver.start.md +++ b/docs/tryorama.trycpserver.start.md @@ -14,10 +14,39 @@ static start(port?: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | _(Optional)_ The network port the server should listen on. | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + +_(Optional)_ The network port the server should listen on. + + +
**Returns:** Promise<[TryCpServer](./tryorama.trycpserver.md)>