diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e333217..ea847d50 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,13 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ### Changed ### Fixed +## 2023-10-04: v0.15.1 +### Added +- Awaiting DHT sync: Add duplicated functions `conductorCellDhtSync` and `isConductorCellDhtEqual` of existing functions `dhtSync` and make the prior versions aliases to these. New versions take in an `IConductorCell` which just wraps an `IConductor` and `CellId`. +### Fixed +- Security bump: `webpki` to v0.22.2 +- Security bump: `@microsoft/api-extractor` to v7.36.2 + ## 2023-08-07: v0.15.0 ### Added - Export all common helper functions. diff --git a/docs/tryorama.addallagentstoallconductors.md b/docs/tryorama.addallagentstoallconductors.md index d0310075..9ddf0bba 100644 --- a/docs/tryorama.addallagentstoallconductors.md +++ b/docs/tryorama.addallagentstoallconductors.md @@ -6,7 +6,7 @@ Add all agents of all conductors to each other. Shortcuts peer discovery through a bootstrap server or gossiping. -Signature: +**Signature:** ```typescript addAllAgentsToAllConductors: (conductors: IConductor[]) => Promise diff --git a/docs/tryorama.adminapiresponse.md b/docs/tryorama.adminapiresponse.md index dcd18daa..e491efdd 100644 --- a/docs/tryorama.adminapiresponse.md +++ b/docs/tryorama.adminapiresponse.md @@ -6,10 +6,10 @@ All possible responses from the Admin API. -Signature: +**Signature:** ```typescript export type AdminApiResponse = AdminApiResponseAgentInfo | AdminApiResponseAgentInfoAdded | AdminApiResponseAgentPubKeyGenerated | AdminApiResponseAppDisabled | AdminApiResponseAppEnabled | AdminApiResponseAppInstalled | AdminApiResponseAppInterfaceAttached | AdminApiResponseAppInterfacesListed | AdminApiResponseAppStarted | AdminApiResponseAppUninstalled | AdminApiResponseAppsListed | AdminApiResponseCellIdsListed | AdminApiResponseCloneCellDeleted | AdminApiResponseCoordinatorsUpdated | AdminApiResponseDnasDefinitionReturned | AdminApiResponseDnasListed | AdminApiResponseDnaRegistered | AdminApiResponseFullStateDumped | AdminApiResponseNetworkStatsDumped | AdminApiResponseStateDumped | AdminApiResponseStorageInfo | AdminApiResponseZomeCallCapabilityGranted; ``` -References: [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), [AdminApiResponseAppStarted](./tryorama.adminapiresponseappstarted.md), [AdminApiResponseAppUninstalled](./tryorama.adminapiresponseappuninstalled.md), [AdminApiResponseAppsListed](./tryorama.adminapiresponseappslisted.md), [AdminApiResponseCellIdsListed](./tryorama.adminapiresponsecellidslisted.md), [AdminApiResponseCloneCellDeleted](./tryorama.adminapiresponseclonecelldeleted.md), [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md), [AdminApiResponseDnasDefinitionReturned](./tryorama.adminapiresponsednasdefinitionreturned.md), [AdminApiResponseDnasListed](./tryorama.adminapiresponsednaslisted.md), [AdminApiResponseDnaRegistered](./tryorama.adminapiresponsednaregistered.md), [AdminApiResponseFullStateDumped](./tryorama.adminapiresponsefullstatedumped.md), [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md), [AdminApiResponseStateDumped](./tryorama.adminapiresponsestatedumped.md), [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md), [AdminApiResponseZomeCallCapabilityGranted](./tryorama.adminapiresponsezomecallcapabilitygranted.md) +**References:** [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), [AdminApiResponseAppStarted](./tryorama.adminapiresponseappstarted.md), [AdminApiResponseAppUninstalled](./tryorama.adminapiresponseappuninstalled.md), [AdminApiResponseAppsListed](./tryorama.adminapiresponseappslisted.md), [AdminApiResponseCellIdsListed](./tryorama.adminapiresponsecellidslisted.md), [AdminApiResponseCloneCellDeleted](./tryorama.adminapiresponseclonecelldeleted.md), [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md), [AdminApiResponseDnasDefinitionReturned](./tryorama.adminapiresponsednasdefinitionreturned.md), [AdminApiResponseDnasListed](./tryorama.adminapiresponsednaslisted.md), [AdminApiResponseDnaRegistered](./tryorama.adminapiresponsednaregistered.md), [AdminApiResponseFullStateDumped](./tryorama.adminapiresponsefullstatedumped.md), [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md), [AdminApiResponseStateDumped](./tryorama.adminapiresponsestatedumped.md), [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md), [AdminApiResponseZomeCallCapabilityGranted](./tryorama.adminapiresponsezomecallcapabilitygranted.md) diff --git a/docs/tryorama.adminapiresponseagentinfo.data.md b/docs/tryorama.adminapiresponseagentinfo.data.md index fbf8a070..ec035f76 100644 --- a/docs/tryorama.adminapiresponseagentinfo.data.md +++ b/docs/tryorama.adminapiresponseagentinfo.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAgentInfo.data property -Signature: +**Signature:** ```typescript data: AgentInfoResponse; diff --git a/docs/tryorama.adminapiresponseagentinfo.md b/docs/tryorama.adminapiresponseagentinfo.md index d0c8a8f1..15da1e60 100644 --- a/docs/tryorama.adminapiresponseagentinfo.md +++ b/docs/tryorama.adminapiresponseagentinfo.md @@ -5,7 +5,7 @@ ## AdminApiResponseAgentInfo interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAgentInfo diff --git a/docs/tryorama.adminapiresponseagentinfo.type.md b/docs/tryorama.adminapiresponseagentinfo.type.md index b5d8d37b..301ed625 100644 --- a/docs/tryorama.adminapiresponseagentinfo.type.md +++ b/docs/tryorama.adminapiresponseagentinfo.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAgentInfo.type property -Signature: +**Signature:** ```typescript type: "agent_info"; diff --git a/docs/tryorama.adminapiresponseagentinfoadded.md b/docs/tryorama.adminapiresponseagentinfoadded.md index 4434b354..ce575dab 100644 --- a/docs/tryorama.adminapiresponseagentinfoadded.md +++ b/docs/tryorama.adminapiresponseagentinfoadded.md @@ -5,7 +5,7 @@ ## AdminApiResponseAgentInfoAdded interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAgentInfoAdded diff --git a/docs/tryorama.adminapiresponseagentinfoadded.type.md b/docs/tryorama.adminapiresponseagentinfoadded.type.md index b7ab4dff..a47dedd1 100644 --- a/docs/tryorama.adminapiresponseagentinfoadded.type.md +++ b/docs/tryorama.adminapiresponseagentinfoadded.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAgentInfoAdded.type property -Signature: +**Signature:** ```typescript type: "agent_info_added"; diff --git a/docs/tryorama.adminapiresponseagentpubkeygenerated.data.md b/docs/tryorama.adminapiresponseagentpubkeygenerated.data.md index e72cd0cb..b1170f3a 100644 --- a/docs/tryorama.adminapiresponseagentpubkeygenerated.data.md +++ b/docs/tryorama.adminapiresponseagentpubkeygenerated.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAgentPubKeyGenerated.data property -Signature: +**Signature:** ```typescript data: HoloHash; diff --git a/docs/tryorama.adminapiresponseagentpubkeygenerated.md b/docs/tryorama.adminapiresponseagentpubkeygenerated.md index 2116f4a6..6486c81a 100644 --- a/docs/tryorama.adminapiresponseagentpubkeygenerated.md +++ b/docs/tryorama.adminapiresponseagentpubkeygenerated.md @@ -5,7 +5,7 @@ ## AdminApiResponseAgentPubKeyGenerated interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAgentPubKeyGenerated diff --git a/docs/tryorama.adminapiresponseagentpubkeygenerated.type.md b/docs/tryorama.adminapiresponseagentpubkeygenerated.type.md index 3df3b786..a8a8357d 100644 --- a/docs/tryorama.adminapiresponseagentpubkeygenerated.type.md +++ b/docs/tryorama.adminapiresponseagentpubkeygenerated.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAgentPubKeyGenerated.type property -Signature: +**Signature:** ```typescript type: "agent_pub_key_generated"; diff --git a/docs/tryorama.adminapiresponseappdisabled.data.md b/docs/tryorama.adminapiresponseappdisabled.data.md index b7755ab0..30533944 100644 --- a/docs/tryorama.adminapiresponseappdisabled.data.md +++ b/docs/tryorama.adminapiresponseappdisabled.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppDisabled.data property -Signature: +**Signature:** ```typescript data: DisableAppResponse; diff --git a/docs/tryorama.adminapiresponseappdisabled.md b/docs/tryorama.adminapiresponseappdisabled.md index 5cb9fd6b..eecd3ffe 100644 --- a/docs/tryorama.adminapiresponseappdisabled.md +++ b/docs/tryorama.adminapiresponseappdisabled.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppDisabled interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppDisabled diff --git a/docs/tryorama.adminapiresponseappdisabled.type.md b/docs/tryorama.adminapiresponseappdisabled.type.md index 169f703b..6001ca43 100644 --- a/docs/tryorama.adminapiresponseappdisabled.type.md +++ b/docs/tryorama.adminapiresponseappdisabled.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppDisabled.type property -Signature: +**Signature:** ```typescript type: "app_disabled"; diff --git a/docs/tryorama.adminapiresponseappenabled.data.md b/docs/tryorama.adminapiresponseappenabled.data.md index 5d47ce8e..f00a4be3 100644 --- a/docs/tryorama.adminapiresponseappenabled.data.md +++ b/docs/tryorama.adminapiresponseappenabled.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppEnabled.data property -Signature: +**Signature:** ```typescript data: EnableAppResponse; diff --git a/docs/tryorama.adminapiresponseappenabled.md b/docs/tryorama.adminapiresponseappenabled.md index 7306d4bc..fb4fcd16 100644 --- a/docs/tryorama.adminapiresponseappenabled.md +++ b/docs/tryorama.adminapiresponseappenabled.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppEnabled interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppEnabled diff --git a/docs/tryorama.adminapiresponseappenabled.type.md b/docs/tryorama.adminapiresponseappenabled.type.md index ada4f2d8..ac90be92 100644 --- a/docs/tryorama.adminapiresponseappenabled.type.md +++ b/docs/tryorama.adminapiresponseappenabled.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppEnabled.type property -Signature: +**Signature:** ```typescript type: "app_enabled"; diff --git a/docs/tryorama.adminapiresponseappinstalled.data.md b/docs/tryorama.adminapiresponseappinstalled.data.md index d74cd2b2..7d870297 100644 --- a/docs/tryorama.adminapiresponseappinstalled.data.md +++ b/docs/tryorama.adminapiresponseappinstalled.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppInstalled.data property -Signature: +**Signature:** ```typescript data: AppInfo; diff --git a/docs/tryorama.adminapiresponseappinstalled.md b/docs/tryorama.adminapiresponseappinstalled.md index f0347501..c93db3ee 100644 --- a/docs/tryorama.adminapiresponseappinstalled.md +++ b/docs/tryorama.adminapiresponseappinstalled.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppInstalled interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppInstalled diff --git a/docs/tryorama.adminapiresponseappinstalled.type.md b/docs/tryorama.adminapiresponseappinstalled.type.md index 39d3d3ab..ec91b27d 100644 --- a/docs/tryorama.adminapiresponseappinstalled.type.md +++ b/docs/tryorama.adminapiresponseappinstalled.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppInstalled.type property -Signature: +**Signature:** ```typescript type: "app_installed"; diff --git a/docs/tryorama.adminapiresponseappinterfaceattached.data.md b/docs/tryorama.adminapiresponseappinterfaceattached.data.md index 2d07cb5b..dc2b3454 100644 --- a/docs/tryorama.adminapiresponseappinterfaceattached.data.md +++ b/docs/tryorama.adminapiresponseappinterfaceattached.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppInterfaceAttached.data property -Signature: +**Signature:** ```typescript data: AttachAppInterfaceResponse; diff --git a/docs/tryorama.adminapiresponseappinterfaceattached.md b/docs/tryorama.adminapiresponseappinterfaceattached.md index 9ba17203..3fe9b07d 100644 --- a/docs/tryorama.adminapiresponseappinterfaceattached.md +++ b/docs/tryorama.adminapiresponseappinterfaceattached.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppInterfaceAttached interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppInterfaceAttached diff --git a/docs/tryorama.adminapiresponseappinterfaceattached.type.md b/docs/tryorama.adminapiresponseappinterfaceattached.type.md index b68bad84..d58dd31d 100644 --- a/docs/tryorama.adminapiresponseappinterfaceattached.type.md +++ b/docs/tryorama.adminapiresponseappinterfaceattached.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppInterfaceAttached.type property -Signature: +**Signature:** ```typescript type: "app_interface_attached"; diff --git a/docs/tryorama.adminapiresponseappinterfaceslisted.data.md b/docs/tryorama.adminapiresponseappinterfaceslisted.data.md index da4c8efe..430929ed 100644 --- a/docs/tryorama.adminapiresponseappinterfaceslisted.data.md +++ b/docs/tryorama.adminapiresponseappinterfaceslisted.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppInterfacesListed.data property -Signature: +**Signature:** ```typescript data: ListAppInterfacesResponse; diff --git a/docs/tryorama.adminapiresponseappinterfaceslisted.md b/docs/tryorama.adminapiresponseappinterfaceslisted.md index cfe21e0a..794597ba 100644 --- a/docs/tryorama.adminapiresponseappinterfaceslisted.md +++ b/docs/tryorama.adminapiresponseappinterfaceslisted.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppInterfacesListed interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppInterfacesListed diff --git a/docs/tryorama.adminapiresponseappinterfaceslisted.type.md b/docs/tryorama.adminapiresponseappinterfaceslisted.type.md index 33d4829d..6409f9f8 100644 --- a/docs/tryorama.adminapiresponseappinterfaceslisted.type.md +++ b/docs/tryorama.adminapiresponseappinterfaceslisted.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppInterfacesListed.type property -Signature: +**Signature:** ```typescript type: "app_interfaces_listed"; diff --git a/docs/tryorama.adminapiresponseappslisted.data.md b/docs/tryorama.adminapiresponseappslisted.data.md index 8d80d74f..f67dfd15 100644 --- a/docs/tryorama.adminapiresponseappslisted.data.md +++ b/docs/tryorama.adminapiresponseappslisted.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppsListed.data property -Signature: +**Signature:** ```typescript data: ListAppsResponse; diff --git a/docs/tryorama.adminapiresponseappslisted.md b/docs/tryorama.adminapiresponseappslisted.md index 10de592f..e4a5dc7f 100644 --- a/docs/tryorama.adminapiresponseappslisted.md +++ b/docs/tryorama.adminapiresponseappslisted.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppsListed interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppsListed diff --git a/docs/tryorama.adminapiresponseappslisted.type.md b/docs/tryorama.adminapiresponseappslisted.type.md index 184a48d3..29a5c157 100644 --- a/docs/tryorama.adminapiresponseappslisted.type.md +++ b/docs/tryorama.adminapiresponseappslisted.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppsListed.type property -Signature: +**Signature:** ```typescript type: "apps_listed"; diff --git a/docs/tryorama.adminapiresponseappstarted.data.md b/docs/tryorama.adminapiresponseappstarted.data.md index df7943df..8ea3d7e6 100644 --- a/docs/tryorama.adminapiresponseappstarted.data.md +++ b/docs/tryorama.adminapiresponseappstarted.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppStarted.data property -Signature: +**Signature:** ```typescript data: StartAppResponse; diff --git a/docs/tryorama.adminapiresponseappstarted.md b/docs/tryorama.adminapiresponseappstarted.md index 5e4d7d96..c3a8d809 100644 --- a/docs/tryorama.adminapiresponseappstarted.md +++ b/docs/tryorama.adminapiresponseappstarted.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppStarted interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppStarted diff --git a/docs/tryorama.adminapiresponseappstarted.type.md b/docs/tryorama.adminapiresponseappstarted.type.md index 378c7753..7aeae603 100644 --- a/docs/tryorama.adminapiresponseappstarted.type.md +++ b/docs/tryorama.adminapiresponseappstarted.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppStarted.type property -Signature: +**Signature:** ```typescript type: "app_started"; diff --git a/docs/tryorama.adminapiresponseappuninstalled.data.md b/docs/tryorama.adminapiresponseappuninstalled.data.md index cef423d0..36028ba1 100644 --- a/docs/tryorama.adminapiresponseappuninstalled.data.md +++ b/docs/tryorama.adminapiresponseappuninstalled.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppUninstalled.data property -Signature: +**Signature:** ```typescript data: UninstallAppResponse; diff --git a/docs/tryorama.adminapiresponseappuninstalled.md b/docs/tryorama.adminapiresponseappuninstalled.md index dde017bf..1909e467 100644 --- a/docs/tryorama.adminapiresponseappuninstalled.md +++ b/docs/tryorama.adminapiresponseappuninstalled.md @@ -5,7 +5,7 @@ ## AdminApiResponseAppUninstalled interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseAppUninstalled diff --git a/docs/tryorama.adminapiresponseappuninstalled.type.md b/docs/tryorama.adminapiresponseappuninstalled.type.md index df5dc3d8..c6d64b15 100644 --- a/docs/tryorama.adminapiresponseappuninstalled.type.md +++ b/docs/tryorama.adminapiresponseappuninstalled.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseAppUninstalled.type property -Signature: +**Signature:** ```typescript type: "app_uninstalled"; diff --git a/docs/tryorama.adminapiresponsecellidslisted.data.md b/docs/tryorama.adminapiresponsecellidslisted.data.md index 1b4544c7..6c2241d6 100644 --- a/docs/tryorama.adminapiresponsecellidslisted.data.md +++ b/docs/tryorama.adminapiresponsecellidslisted.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseCellIdsListed.data property -Signature: +**Signature:** ```typescript data: ListCellIdsResponse; diff --git a/docs/tryorama.adminapiresponsecellidslisted.md b/docs/tryorama.adminapiresponsecellidslisted.md index 4b323773..2ca27cc6 100644 --- a/docs/tryorama.adminapiresponsecellidslisted.md +++ b/docs/tryorama.adminapiresponsecellidslisted.md @@ -5,7 +5,7 @@ ## AdminApiResponseCellIdsListed interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseCellIdsListed diff --git a/docs/tryorama.adminapiresponsecellidslisted.type.md b/docs/tryorama.adminapiresponsecellidslisted.type.md index 01aebce3..3b77cecf 100644 --- a/docs/tryorama.adminapiresponsecellidslisted.type.md +++ b/docs/tryorama.adminapiresponsecellidslisted.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseCellIdsListed.type property -Signature: +**Signature:** ```typescript type: "cell_ids_listed"; diff --git a/docs/tryorama.adminapiresponseclonecelldeleted.md b/docs/tryorama.adminapiresponseclonecelldeleted.md index c29d5a51..33bf1838 100644 --- a/docs/tryorama.adminapiresponseclonecelldeleted.md +++ b/docs/tryorama.adminapiresponseclonecelldeleted.md @@ -5,7 +5,7 @@ ## AdminApiResponseCloneCellDeleted interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseCloneCellDeleted diff --git a/docs/tryorama.adminapiresponseclonecelldeleted.type.md b/docs/tryorama.adminapiresponseclonecelldeleted.type.md index a19bb695..da50c7bc 100644 --- a/docs/tryorama.adminapiresponseclonecelldeleted.type.md +++ b/docs/tryorama.adminapiresponseclonecelldeleted.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseCloneCellDeleted.type property -Signature: +**Signature:** ```typescript type: "clone_cell_deleted"; diff --git a/docs/tryorama.adminapiresponsecoordinatorsupdated.data.md b/docs/tryorama.adminapiresponsecoordinatorsupdated.data.md index 337c46d0..e69284d5 100644 --- a/docs/tryorama.adminapiresponsecoordinatorsupdated.data.md +++ b/docs/tryorama.adminapiresponsecoordinatorsupdated.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseCoordinatorsUpdated.data property -Signature: +**Signature:** ```typescript data: UpdateCoordinatorsResponse; diff --git a/docs/tryorama.adminapiresponsecoordinatorsupdated.md b/docs/tryorama.adminapiresponsecoordinatorsupdated.md index 9ed6027c..38201902 100644 --- a/docs/tryorama.adminapiresponsecoordinatorsupdated.md +++ b/docs/tryorama.adminapiresponsecoordinatorsupdated.md @@ -5,7 +5,7 @@ ## AdminApiResponseCoordinatorsUpdated interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseCoordinatorsUpdated diff --git a/docs/tryorama.adminapiresponsecoordinatorsupdated.type.md b/docs/tryorama.adminapiresponsecoordinatorsupdated.type.md index 5dd974b8..2a2ab006 100644 --- a/docs/tryorama.adminapiresponsecoordinatorsupdated.type.md +++ b/docs/tryorama.adminapiresponsecoordinatorsupdated.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseCoordinatorsUpdated.type property -Signature: +**Signature:** ```typescript type: "coordinators_updated"; diff --git a/docs/tryorama.adminapiresponsednaregistered.data.md b/docs/tryorama.adminapiresponsednaregistered.data.md index 14f2f5e4..c6ad76b7 100644 --- a/docs/tryorama.adminapiresponsednaregistered.data.md +++ b/docs/tryorama.adminapiresponsednaregistered.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseDnaRegistered.data property -Signature: +**Signature:** ```typescript data: HoloHash; diff --git a/docs/tryorama.adminapiresponsednaregistered.md b/docs/tryorama.adminapiresponsednaregistered.md index 9e8bbf19..6e72f050 100644 --- a/docs/tryorama.adminapiresponsednaregistered.md +++ b/docs/tryorama.adminapiresponsednaregistered.md @@ -5,7 +5,7 @@ ## AdminApiResponseDnaRegistered interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseDnaRegistered diff --git a/docs/tryorama.adminapiresponsednaregistered.type.md b/docs/tryorama.adminapiresponsednaregistered.type.md index 9830275c..a8188e34 100644 --- a/docs/tryorama.adminapiresponsednaregistered.type.md +++ b/docs/tryorama.adminapiresponsednaregistered.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseDnaRegistered.type property -Signature: +**Signature:** ```typescript type: "dna_registered"; diff --git a/docs/tryorama.adminapiresponsednasdefinitionreturned.data.md b/docs/tryorama.adminapiresponsednasdefinitionreturned.data.md index e10faf2b..27fff952 100644 --- a/docs/tryorama.adminapiresponsednasdefinitionreturned.data.md +++ b/docs/tryorama.adminapiresponsednasdefinitionreturned.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseDnasDefinitionReturned.data property -Signature: +**Signature:** ```typescript data: DnaDefinition; diff --git a/docs/tryorama.adminapiresponsednasdefinitionreturned.md b/docs/tryorama.adminapiresponsednasdefinitionreturned.md index 66036649..f9b12abe 100644 --- a/docs/tryorama.adminapiresponsednasdefinitionreturned.md +++ b/docs/tryorama.adminapiresponsednasdefinitionreturned.md @@ -5,7 +5,7 @@ ## AdminApiResponseDnasDefinitionReturned interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseDnasDefinitionReturned diff --git a/docs/tryorama.adminapiresponsednasdefinitionreturned.type.md b/docs/tryorama.adminapiresponsednasdefinitionreturned.type.md index 4c61532f..d8338576 100644 --- a/docs/tryorama.adminapiresponsednasdefinitionreturned.type.md +++ b/docs/tryorama.adminapiresponsednasdefinitionreturned.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseDnasDefinitionReturned.type property -Signature: +**Signature:** ```typescript type: "dna_definition_returned"; diff --git a/docs/tryorama.adminapiresponsednaslisted.data.md b/docs/tryorama.adminapiresponsednaslisted.data.md index 1329d62c..a011c7a7 100644 --- a/docs/tryorama.adminapiresponsednaslisted.data.md +++ b/docs/tryorama.adminapiresponsednaslisted.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseDnasListed.data property -Signature: +**Signature:** ```typescript data: ListDnasResponse; diff --git a/docs/tryorama.adminapiresponsednaslisted.md b/docs/tryorama.adminapiresponsednaslisted.md index 5db29351..337f8c55 100644 --- a/docs/tryorama.adminapiresponsednaslisted.md +++ b/docs/tryorama.adminapiresponsednaslisted.md @@ -5,7 +5,7 @@ ## AdminApiResponseDnasListed interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseDnasListed diff --git a/docs/tryorama.adminapiresponsednaslisted.type.md b/docs/tryorama.adminapiresponsednaslisted.type.md index bbea944a..911b631e 100644 --- a/docs/tryorama.adminapiresponsednaslisted.type.md +++ b/docs/tryorama.adminapiresponsednaslisted.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseDnasListed.type property -Signature: +**Signature:** ```typescript type: "dnas_listed"; diff --git a/docs/tryorama.adminapiresponsefullstatedumped.data.md b/docs/tryorama.adminapiresponsefullstatedumped.data.md index 27f0729f..d8219519 100644 --- a/docs/tryorama.adminapiresponsefullstatedumped.data.md +++ b/docs/tryorama.adminapiresponsefullstatedumped.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseFullStateDumped.data property -Signature: +**Signature:** ```typescript data: FullStateDump; diff --git a/docs/tryorama.adminapiresponsefullstatedumped.md b/docs/tryorama.adminapiresponsefullstatedumped.md index a53f519e..e0771092 100644 --- a/docs/tryorama.adminapiresponsefullstatedumped.md +++ b/docs/tryorama.adminapiresponsefullstatedumped.md @@ -5,7 +5,7 @@ ## AdminApiResponseFullStateDumped interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseFullStateDumped diff --git a/docs/tryorama.adminapiresponsefullstatedumped.type.md b/docs/tryorama.adminapiresponsefullstatedumped.type.md index 902554d2..691fe032 100644 --- a/docs/tryorama.adminapiresponsefullstatedumped.type.md +++ b/docs/tryorama.adminapiresponsefullstatedumped.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseFullStateDumped.type property -Signature: +**Signature:** ```typescript type: "full_state_dumped"; diff --git a/docs/tryorama.adminapiresponsenetworkstatsdumped.data.md b/docs/tryorama.adminapiresponsenetworkstatsdumped.data.md index adec763c..86f9b197 100644 --- a/docs/tryorama.adminapiresponsenetworkstatsdumped.data.md +++ b/docs/tryorama.adminapiresponsenetworkstatsdumped.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseNetworkStatsDumped.data property -Signature: +**Signature:** ```typescript data: DumpNetworkStatsResponse; diff --git a/docs/tryorama.adminapiresponsenetworkstatsdumped.md b/docs/tryorama.adminapiresponsenetworkstatsdumped.md index 8bb3514b..56ead062 100644 --- a/docs/tryorama.adminapiresponsenetworkstatsdumped.md +++ b/docs/tryorama.adminapiresponsenetworkstatsdumped.md @@ -5,7 +5,7 @@ ## AdminApiResponseNetworkStatsDumped interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseNetworkStatsDumped diff --git a/docs/tryorama.adminapiresponsenetworkstatsdumped.type.md b/docs/tryorama.adminapiresponsenetworkstatsdumped.type.md index 697a8d62..85764459 100644 --- a/docs/tryorama.adminapiresponsenetworkstatsdumped.type.md +++ b/docs/tryorama.adminapiresponsenetworkstatsdumped.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseNetworkStatsDumped.type property -Signature: +**Signature:** ```typescript type: "network_stats_dumped"; diff --git a/docs/tryorama.adminapiresponsestatedumped.data.md b/docs/tryorama.adminapiresponsestatedumped.data.md index b8ce0f70..16b8616f 100644 --- a/docs/tryorama.adminapiresponsestatedumped.data.md +++ b/docs/tryorama.adminapiresponsestatedumped.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseStateDumped.data property -Signature: +**Signature:** ```typescript data: DumpStateResponse; diff --git a/docs/tryorama.adminapiresponsestatedumped.md b/docs/tryorama.adminapiresponsestatedumped.md index 4f3a20fe..481260e0 100644 --- a/docs/tryorama.adminapiresponsestatedumped.md +++ b/docs/tryorama.adminapiresponsestatedumped.md @@ -5,7 +5,7 @@ ## AdminApiResponseStateDumped interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseStateDumped diff --git a/docs/tryorama.adminapiresponsestatedumped.type.md b/docs/tryorama.adminapiresponsestatedumped.type.md index e9c79afb..695c603d 100644 --- a/docs/tryorama.adminapiresponsestatedumped.type.md +++ b/docs/tryorama.adminapiresponsestatedumped.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseStateDumped.type property -Signature: +**Signature:** ```typescript type: "state_dumped"; diff --git a/docs/tryorama.adminapiresponsestorageinfo.data.md b/docs/tryorama.adminapiresponsestorageinfo.data.md index edde9f96..2bf77efe 100644 --- a/docs/tryorama.adminapiresponsestorageinfo.data.md +++ b/docs/tryorama.adminapiresponsestorageinfo.data.md @@ -4,7 +4,7 @@ ## AdminApiResponseStorageInfo.data property -Signature: +**Signature:** ```typescript data: StorageInfoResponse; diff --git a/docs/tryorama.adminapiresponsestorageinfo.md b/docs/tryorama.adminapiresponsestorageinfo.md index fd400584..7bfd92d9 100644 --- a/docs/tryorama.adminapiresponsestorageinfo.md +++ b/docs/tryorama.adminapiresponsestorageinfo.md @@ -5,7 +5,7 @@ ## AdminApiResponseStorageInfo interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseStorageInfo diff --git a/docs/tryorama.adminapiresponsestorageinfo.type.md b/docs/tryorama.adminapiresponsestorageinfo.type.md index b7f1c661..a563dd42 100644 --- a/docs/tryorama.adminapiresponsestorageinfo.type.md +++ b/docs/tryorama.adminapiresponsestorageinfo.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseStorageInfo.type property -Signature: +**Signature:** ```typescript type: "storage_info"; diff --git a/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md b/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md index 9fb5bdd3..2d4e315b 100644 --- a/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md +++ b/docs/tryorama.adminapiresponsezomecallcapabilitygranted.md @@ -5,7 +5,7 @@ ## AdminApiResponseZomeCallCapabilityGranted interface -Signature: +**Signature:** ```typescript export interface AdminApiResponseZomeCallCapabilityGranted diff --git a/docs/tryorama.adminapiresponsezomecallcapabilitygranted.type.md b/docs/tryorama.adminapiresponsezomecallcapabilitygranted.type.md index 8d586a96..144f518c 100644 --- a/docs/tryorama.adminapiresponsezomecallcapabilitygranted.type.md +++ b/docs/tryorama.adminapiresponsezomecallcapabilitygranted.type.md @@ -4,7 +4,7 @@ ## AdminApiResponseZomeCallCapabilityGranted.type property -Signature: +**Signature:** ```typescript type: "zome_call_capability_granted"; diff --git a/docs/tryorama.agentapp.agentpubkey.md b/docs/tryorama.agentapp.agentpubkey.md index 5cc4d4fd..bccbd341 100644 --- a/docs/tryorama.agentapp.agentpubkey.md +++ b/docs/tryorama.agentapp.agentpubkey.md @@ -4,7 +4,7 @@ ## AgentApp.agentPubKey property -Signature: +**Signature:** ```typescript agentPubKey: Uint8Array; diff --git a/docs/tryorama.agentapp.appid.md b/docs/tryorama.agentapp.appid.md index 6aa52d26..810539d4 100644 --- a/docs/tryorama.agentapp.appid.md +++ b/docs/tryorama.agentapp.appid.md @@ -4,7 +4,7 @@ ## AgentApp.appId property -Signature: +**Signature:** ```typescript appId: string; diff --git a/docs/tryorama.agentapp.cells.md b/docs/tryorama.agentapp.cells.md index 3697fe87..4fa50f4a 100644 --- a/docs/tryorama.agentapp.cells.md +++ b/docs/tryorama.agentapp.cells.md @@ -4,7 +4,7 @@ ## AgentApp.cells property -Signature: +**Signature:** ```typescript cells: CallableCell[]; diff --git a/docs/tryorama.agentapp.md b/docs/tryorama.agentapp.md index 93fb3398..2524b422 100644 --- a/docs/tryorama.agentapp.md +++ b/docs/tryorama.agentapp.md @@ -6,7 +6,7 @@ Provides direct access to cells of an app and the agent key. -Signature: +**Signature:** ```typescript export interface AgentApp diff --git a/docs/tryorama.agentapp.namedcells.md b/docs/tryorama.agentapp.namedcells.md index 1e9cffc9..bdc97846 100644 --- a/docs/tryorama.agentapp.namedcells.md +++ b/docs/tryorama.agentapp.namedcells.md @@ -4,7 +4,7 @@ ## AgentApp.namedCells property -Signature: +**Signature:** ```typescript namedCells: Map; diff --git a/docs/tryorama.agentsappsoptions.md b/docs/tryorama.agentsappsoptions.md index a4345ca3..b9f1cf77 100644 --- a/docs/tryorama.agentsappsoptions.md +++ b/docs/tryorama.agentsappsoptions.md @@ -6,7 +6,7 @@ An app and an optional agent pub key for each agent. Optionally a network seed to be used for DNA installation. -Signature: +**Signature:** ```typescript export type AgentsAppsOptions = { @@ -17,5 +17,5 @@ export type AgentsAppsOptions = { installedAppId?: InstalledAppId; }; ``` -References: [AppOptions](./tryorama.appoptions.md) +**References:** [AppOptions](./tryorama.appoptions.md) diff --git a/docs/tryorama.apierrorresponse.data.md b/docs/tryorama.apierrorresponse.data.md index a412ec2e..0c066ad3 100644 --- a/docs/tryorama.apierrorresponse.data.md +++ b/docs/tryorama.apierrorresponse.data.md @@ -4,7 +4,7 @@ ## ApiErrorResponse.data property -Signature: +**Signature:** ```typescript data: { diff --git a/docs/tryorama.apierrorresponse.md b/docs/tryorama.apierrorresponse.md index 3bd0f8f7..cd75544d 100644 --- a/docs/tryorama.apierrorresponse.md +++ b/docs/tryorama.apierrorresponse.md @@ -6,7 +6,7 @@ Error response from the Admin or App API. -Signature: +**Signature:** ```typescript export interface ApiErrorResponse diff --git a/docs/tryorama.apierrorresponse.type.md b/docs/tryorama.apierrorresponse.type.md index 9731b9f4..1cbb6be3 100644 --- a/docs/tryorama.apierrorresponse.type.md +++ b/docs/tryorama.apierrorresponse.type.md @@ -4,7 +4,7 @@ ## ApiErrorResponse.type property -Signature: +**Signature:** ```typescript type: "error"; diff --git a/docs/tryorama.appapiresponse.md b/docs/tryorama.appapiresponse.md index fbc1a4fe..cc432922 100644 --- a/docs/tryorama.appapiresponse.md +++ b/docs/tryorama.appapiresponse.md @@ -6,10 +6,10 @@ App API Responses. -Signature: +**Signature:** ```typescript export type AppApiResponse = AppApiResponseAppInfo | AppApiResponseZomeCall | AppApiResponseCloneCellCreated | AppApiResponseCloneCellEnabled | AppApiResponseCloneCellDisabled | AppApiResponseNetworkInfo; ``` -References: [AppApiResponseAppInfo](./tryorama.appapiresponseappinfo.md), [AppApiResponseZomeCall](./tryorama.appapiresponsezomecall.md), [AppApiResponseCloneCellCreated](./tryorama.appapiresponseclonecellcreated.md), [AppApiResponseCloneCellEnabled](./tryorama.appapiresponseclonecellenabled.md), [AppApiResponseCloneCellDisabled](./tryorama.appapiresponseclonecelldisabled.md), [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) +**References:** [AppApiResponseAppInfo](./tryorama.appapiresponseappinfo.md), [AppApiResponseZomeCall](./tryorama.appapiresponsezomecall.md), [AppApiResponseCloneCellCreated](./tryorama.appapiresponseclonecellcreated.md), [AppApiResponseCloneCellEnabled](./tryorama.appapiresponseclonecellenabled.md), [AppApiResponseCloneCellDisabled](./tryorama.appapiresponseclonecelldisabled.md), [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) diff --git a/docs/tryorama.appapiresponseappinfo.data.md b/docs/tryorama.appapiresponseappinfo.data.md index a7b15b2e..2e7d0fa0 100644 --- a/docs/tryorama.appapiresponseappinfo.data.md +++ b/docs/tryorama.appapiresponseappinfo.data.md @@ -4,7 +4,7 @@ ## AppApiResponseAppInfo.data property -Signature: +**Signature:** ```typescript data: AppInfoResponse; diff --git a/docs/tryorama.appapiresponseappinfo.md b/docs/tryorama.appapiresponseappinfo.md index b461e681..1c8149b0 100644 --- a/docs/tryorama.appapiresponseappinfo.md +++ b/docs/tryorama.appapiresponseappinfo.md @@ -5,7 +5,7 @@ ## AppApiResponseAppInfo interface -Signature: +**Signature:** ```typescript export interface AppApiResponseAppInfo diff --git a/docs/tryorama.appapiresponseappinfo.type.md b/docs/tryorama.appapiresponseappinfo.type.md index b25b9a4f..eac82fcb 100644 --- a/docs/tryorama.appapiresponseappinfo.type.md +++ b/docs/tryorama.appapiresponseappinfo.type.md @@ -4,7 +4,7 @@ ## AppApiResponseAppInfo.type property -Signature: +**Signature:** ```typescript type: "app_info"; diff --git a/docs/tryorama.appapiresponseclonecellcreated.data.md b/docs/tryorama.appapiresponseclonecellcreated.data.md index bfb98bc1..ed72076f 100644 --- a/docs/tryorama.appapiresponseclonecellcreated.data.md +++ b/docs/tryorama.appapiresponseclonecellcreated.data.md @@ -4,7 +4,7 @@ ## AppApiResponseCloneCellCreated.data property -Signature: +**Signature:** ```typescript data: CreateCloneCellResponse; diff --git a/docs/tryorama.appapiresponseclonecellcreated.md b/docs/tryorama.appapiresponseclonecellcreated.md index b74e0bdd..efc9d6e5 100644 --- a/docs/tryorama.appapiresponseclonecellcreated.md +++ b/docs/tryorama.appapiresponseclonecellcreated.md @@ -5,7 +5,7 @@ ## AppApiResponseCloneCellCreated interface -Signature: +**Signature:** ```typescript export interface AppApiResponseCloneCellCreated diff --git a/docs/tryorama.appapiresponseclonecellcreated.type.md b/docs/tryorama.appapiresponseclonecellcreated.type.md index 1f3348d8..307dfab8 100644 --- a/docs/tryorama.appapiresponseclonecellcreated.type.md +++ b/docs/tryorama.appapiresponseclonecellcreated.type.md @@ -4,7 +4,7 @@ ## AppApiResponseCloneCellCreated.type property -Signature: +**Signature:** ```typescript type: "clone_cell_created"; diff --git a/docs/tryorama.appapiresponseclonecelldisabled.data.md b/docs/tryorama.appapiresponseclonecelldisabled.data.md index c05ba486..1766013b 100644 --- a/docs/tryorama.appapiresponseclonecelldisabled.data.md +++ b/docs/tryorama.appapiresponseclonecelldisabled.data.md @@ -4,7 +4,7 @@ ## AppApiResponseCloneCellDisabled.data property -Signature: +**Signature:** ```typescript data: DisableCloneCellResponse; diff --git a/docs/tryorama.appapiresponseclonecelldisabled.md b/docs/tryorama.appapiresponseclonecelldisabled.md index 7d744a90..d74fa475 100644 --- a/docs/tryorama.appapiresponseclonecelldisabled.md +++ b/docs/tryorama.appapiresponseclonecelldisabled.md @@ -5,7 +5,7 @@ ## AppApiResponseCloneCellDisabled interface -Signature: +**Signature:** ```typescript export interface AppApiResponseCloneCellDisabled diff --git a/docs/tryorama.appapiresponseclonecelldisabled.type.md b/docs/tryorama.appapiresponseclonecelldisabled.type.md index 5476950a..b332155a 100644 --- a/docs/tryorama.appapiresponseclonecelldisabled.type.md +++ b/docs/tryorama.appapiresponseclonecelldisabled.type.md @@ -4,7 +4,7 @@ ## AppApiResponseCloneCellDisabled.type property -Signature: +**Signature:** ```typescript type: "clone_cell_disabled"; diff --git a/docs/tryorama.appapiresponseclonecellenabled.data.md b/docs/tryorama.appapiresponseclonecellenabled.data.md index 49ca40ed..0fe94364 100644 --- a/docs/tryorama.appapiresponseclonecellenabled.data.md +++ b/docs/tryorama.appapiresponseclonecellenabled.data.md @@ -4,7 +4,7 @@ ## AppApiResponseCloneCellEnabled.data property -Signature: +**Signature:** ```typescript data: EnableCloneCellResponse; diff --git a/docs/tryorama.appapiresponseclonecellenabled.md b/docs/tryorama.appapiresponseclonecellenabled.md index 6df99fe6..c876247f 100644 --- a/docs/tryorama.appapiresponseclonecellenabled.md +++ b/docs/tryorama.appapiresponseclonecellenabled.md @@ -5,7 +5,7 @@ ## AppApiResponseCloneCellEnabled interface -Signature: +**Signature:** ```typescript export interface AppApiResponseCloneCellEnabled diff --git a/docs/tryorama.appapiresponseclonecellenabled.type.md b/docs/tryorama.appapiresponseclonecellenabled.type.md index 55f908ce..480f377b 100644 --- a/docs/tryorama.appapiresponseclonecellenabled.type.md +++ b/docs/tryorama.appapiresponseclonecellenabled.type.md @@ -4,7 +4,7 @@ ## AppApiResponseCloneCellEnabled.type property -Signature: +**Signature:** ```typescript type: "clone_cell_enabled"; diff --git a/docs/tryorama.appapiresponsenetworkinfo.data.md b/docs/tryorama.appapiresponsenetworkinfo.data.md index ad7da821..321bfc2e 100644 --- a/docs/tryorama.appapiresponsenetworkinfo.data.md +++ b/docs/tryorama.appapiresponsenetworkinfo.data.md @@ -4,7 +4,7 @@ ## AppApiResponseNetworkInfo.data property -Signature: +**Signature:** ```typescript data: NetworkInfoResponse; diff --git a/docs/tryorama.appapiresponsenetworkinfo.md b/docs/tryorama.appapiresponsenetworkinfo.md index 4bff668e..a1e44dc8 100644 --- a/docs/tryorama.appapiresponsenetworkinfo.md +++ b/docs/tryorama.appapiresponsenetworkinfo.md @@ -5,7 +5,7 @@ ## AppApiResponseNetworkInfo interface -Signature: +**Signature:** ```typescript export interface AppApiResponseNetworkInfo diff --git a/docs/tryorama.appapiresponsenetworkinfo.type.md b/docs/tryorama.appapiresponsenetworkinfo.type.md index 9e260c06..4d7383a6 100644 --- a/docs/tryorama.appapiresponsenetworkinfo.type.md +++ b/docs/tryorama.appapiresponsenetworkinfo.type.md @@ -4,7 +4,7 @@ ## AppApiResponseNetworkInfo.type property -Signature: +**Signature:** ```typescript type: "network_info"; diff --git a/docs/tryorama.appapiresponsezomecall.data.md b/docs/tryorama.appapiresponsezomecall.data.md index 10e3b6c9..18bbd892 100644 --- a/docs/tryorama.appapiresponsezomecall.data.md +++ b/docs/tryorama.appapiresponsezomecall.data.md @@ -4,7 +4,7 @@ ## AppApiResponseZomeCall.data property -Signature: +**Signature:** ```typescript data: Uint8Array; diff --git a/docs/tryorama.appapiresponsezomecall.md b/docs/tryorama.appapiresponsezomecall.md index 9b51f587..eaff975f 100644 --- a/docs/tryorama.appapiresponsezomecall.md +++ b/docs/tryorama.appapiresponsezomecall.md @@ -5,7 +5,7 @@ ## AppApiResponseZomeCall interface -Signature: +**Signature:** ```typescript export interface AppApiResponseZomeCall diff --git a/docs/tryorama.appapiresponsezomecall.type.md b/docs/tryorama.appapiresponsezomecall.type.md index 68a0f763..cbdedd8f 100644 --- a/docs/tryorama.appapiresponsezomecall.type.md +++ b/docs/tryorama.appapiresponsezomecall.type.md @@ -4,7 +4,7 @@ ## AppApiResponseZomeCall.type property -Signature: +**Signature:** ```typescript type: "zome_call"; diff --git a/docs/tryorama.appoptions.agentpubkey.md b/docs/tryorama.appoptions.agentpubkey.md index 66bbe8ce..ed8240c9 100644 --- a/docs/tryorama.appoptions.agentpubkey.md +++ b/docs/tryorama.appoptions.agentpubkey.md @@ -4,7 +4,7 @@ ## AppOptions.agentPubKey property -Signature: +**Signature:** ```typescript agentPubKey?: AgentPubKey; diff --git a/docs/tryorama.appoptions.installedappid.md b/docs/tryorama.appoptions.installedappid.md index 3e45cacd..fe54bb4d 100644 --- a/docs/tryorama.appoptions.installedappid.md +++ b/docs/tryorama.appoptions.installedappid.md @@ -6,7 +6,7 @@ App ID to override the app manifest's app name. -Signature: +**Signature:** ```typescript installedAppId?: string; diff --git a/docs/tryorama.appoptions.md b/docs/tryorama.appoptions.md index d0377760..5beb0955 100644 --- a/docs/tryorama.appoptions.md +++ b/docs/tryorama.appoptions.md @@ -6,7 +6,7 @@ Optional arguments when installing a hApp. -Signature: +**Signature:** ```typescript export interface AppOptions @@ -16,9 +16,9 @@ export interface AppOptions | 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. | +| [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.appoptions.membraneproofs.md b/docs/tryorama.appoptions.membraneproofs.md index 1a4ea664..2d29defb 100644 --- a/docs/tryorama.appoptions.membraneproofs.md +++ b/docs/tryorama.appoptions.membraneproofs.md @@ -6,7 +6,7 @@ Proofs of membership for the hApp. -Signature: +**Signature:** ```typescript membraneProofs?: Record; diff --git a/docs/tryorama.appoptions.networkseed.md b/docs/tryorama.appoptions.networkseed.md index 66b520ee..56524246 100644 --- a/docs/tryorama.appoptions.networkseed.md +++ b/docs/tryorama.appoptions.networkseed.md @@ -6,7 +6,7 @@ A network seed to override the hApps' network seed. -Signature: +**Signature:** ```typescript networkSeed?: string; diff --git a/docs/tryorama.appoptions.signalhandler.md b/docs/tryorama.appoptions.signalhandler.md index 486f9b0a..64094b84 100644 --- a/docs/tryorama.appoptions.signalhandler.md +++ b/docs/tryorama.appoptions.signalhandler.md @@ -6,7 +6,7 @@ A signal handler for the conductor. -Signature: +**Signature:** ```typescript signalHandler?: AppSignalCb; diff --git a/docs/tryorama.areconductorcellsdhtssynced.md b/docs/tryorama.areconductorcellsdhtssynced.md new file mode 100644 index 00000000..afbc4dae --- /dev/null +++ b/docs/tryorama.areconductorcellsdhtssynced.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [areConductorCellsDhtsSynced](./tryorama.areconductorcellsdhtssynced.md) + +## areConductorCellsDhtsSynced variable + +A utility function to compare conductors' integrated DhtOps. + +**Signature:** + +```typescript +areConductorCellsDhtsSynced: (conductorCells: IConductorCell[]) => Promise +``` diff --git a/docs/tryorama.aredhtssynced.md b/docs/tryorama.aredhtssynced.md index 5f713d6b..b34e06fb 100644 --- a/docs/tryorama.aredhtssynced.md +++ b/docs/tryorama.aredhtssynced.md @@ -6,7 +6,7 @@ A utility function to compare conductors' integrated DhtOps. -Signature: +**Signature:** ```typescript areDhtsSynced: (players: IPlayer[], dnaHash: DnaHash) => Promise diff --git a/docs/tryorama.callablecell.md b/docs/tryorama.callablecell.md index ea7afb0c..059a1b6e 100644 --- a/docs/tryorama.callablecell.md +++ b/docs/tryorama.callablecell.md @@ -6,12 +6,12 @@ Extends an installed cell by a function to call a zome. -Signature: +**Signature:** ```typescript export type CallableCell = Pick & Partial & Partial & { callZome: CallZomeFn; }; ``` -References: [CallZomeFn](./tryorama.callzomefn.md) +**References:** [CallZomeFn](./tryorama.callzomefn.md) diff --git a/docs/tryorama.callzomefn.md b/docs/tryorama.callzomefn.md index 974d72b3..650f8332 100644 --- a/docs/tryorama.callzomefn.md +++ b/docs/tryorama.callzomefn.md @@ -6,10 +6,10 @@ The function for calling a zome from a specific cell. -Signature: +**Signature:** ```typescript export type CallZomeFn = (request: CellZomeCallRequest, timeout?: number) => Promise; ``` -References: [CellZomeCallRequest](./tryorama.cellzomecallrequest.md) +**References:** [CellZomeCallRequest](./tryorama.cellzomecallrequest.md) diff --git a/docs/tryorama.cellzomecallrequest.md b/docs/tryorama.cellzomecallrequest.md index 86ea45fd..9c1861e2 100644 --- a/docs/tryorama.cellzomecallrequest.md +++ b/docs/tryorama.cellzomecallrequest.md @@ -6,7 +6,7 @@ The zome request options adapted to a specific cell. -Signature: +**Signature:** ```typescript export type CellZomeCallRequest = Omit & { diff --git a/docs/tryorama.cleanallconductors.md b/docs/tryorama.cleanallconductors.md index ddf878d7..460c616f 100644 --- a/docs/tryorama.cleanallconductors.md +++ b/docs/tryorama.cleanallconductors.md @@ -6,7 +6,7 @@ Run the `hc` command to delete all conductor data. -Signature: +**Signature:** ```typescript cleanAllConductors: () => Promise diff --git a/docs/tryorama.clientplayers.client.md b/docs/tryorama.clientplayers.client.md index 8c6cdfaa..719e89b5 100644 --- a/docs/tryorama.clientplayers.client.md +++ b/docs/tryorama.clientplayers.client.md @@ -4,7 +4,7 @@ ## ClientPlayers.client property -Signature: +**Signature:** ```typescript client: TryCpClient; diff --git a/docs/tryorama.clientplayers.md b/docs/tryorama.clientplayers.md index fcc353f5..83d247da 100644 --- a/docs/tryorama.clientplayers.md +++ b/docs/tryorama.clientplayers.md @@ -6,7 +6,7 @@ A TryCP client and its associated players. -Signature: +**Signature:** ```typescript export interface ClientPlayers diff --git a/docs/tryorama.clientplayers.players.md b/docs/tryorama.clientplayers.players.md index a1be3e3f..032f39b9 100644 --- a/docs/tryorama.clientplayers.players.md +++ b/docs/tryorama.clientplayers.players.md @@ -4,7 +4,7 @@ ## ClientPlayers.players property -Signature: +**Signature:** ```typescript players: TryCpPlayer[]; diff --git a/docs/tryorama.clientsplayersoptions.agentpubkeys.md b/docs/tryorama.clientsplayersoptions.agentpubkeys.md index a64ed540..837f7859 100644 --- a/docs/tryorama.clientsplayersoptions.agentpubkeys.md +++ b/docs/tryorama.clientsplayersoptions.agentpubkeys.md @@ -6,7 +6,7 @@ A list of previously generated agent pub keys (optional). -Signature: +**Signature:** ```typescript agentPubKeys?: AgentPubKey[]; diff --git a/docs/tryorama.clientsplayersoptions.app.md b/docs/tryorama.clientsplayersoptions.app.md index 64e2c4b4..5fc90dda 100644 --- a/docs/tryorama.clientsplayersoptions.app.md +++ b/docs/tryorama.clientsplayersoptions.app.md @@ -6,7 +6,7 @@ An app that will be installed for each agent. -Signature: +**Signature:** ```typescript app: AppBundleSource; diff --git a/docs/tryorama.clientsplayersoptions.clienttimeout.md b/docs/tryorama.clientsplayersoptions.clienttimeout.md index db9db98d..14d44f7c 100644 --- a/docs/tryorama.clientsplayersoptions.clienttimeout.md +++ b/docs/tryorama.clientsplayersoptions.clienttimeout.md @@ -6,7 +6,7 @@ A timeout for the web socket connection (optional). -Signature: +**Signature:** ```typescript clientTimeout?: number; diff --git a/docs/tryorama.clientsplayersoptions.md b/docs/tryorama.clientsplayersoptions.md index b49f337f..77a7dc12 100644 --- a/docs/tryorama.clientsplayersoptions.md +++ b/docs/tryorama.clientsplayersoptions.md @@ -5,7 +5,7 @@ ## ClientsPlayersOptions interface -Signature: +**Signature:** ```typescript export interface ClientsPlayersOptions @@ -15,11 +15,11 @@ export interface ClientsPlayersOptions | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [agentPubKeys?](./tryorama.clientsplayersoptions.agentpubkeys.md) | | AgentPubKey\[\] | (Optional) A list of previously generated agent pub keys (optional). | +| [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. | +| [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.clientsplayersoptions.numberofagentsperconductor.md b/docs/tryorama.clientsplayersoptions.numberofagentsperconductor.md index cd7421b9..5f0bdfc4 100644 --- a/docs/tryorama.clientsplayersoptions.numberofagentsperconductor.md +++ b/docs/tryorama.clientsplayersoptions.numberofagentsperconductor.md @@ -6,7 +6,7 @@ Number of agents per conductor. Defaults to 1. -Signature: +**Signature:** ```typescript numberOfAgentsPerConductor?: number; diff --git a/docs/tryorama.clientsplayersoptions.numberofconductorsperclient.md b/docs/tryorama.clientsplayersoptions.numberofconductorsperclient.md index dd83898c..ebf55f21 100644 --- a/docs/tryorama.clientsplayersoptions.numberofconductorsperclient.md +++ b/docs/tryorama.clientsplayersoptions.numberofconductorsperclient.md @@ -6,7 +6,7 @@ Number of conductors per client. Defaults to 1. -Signature: +**Signature:** ```typescript numberOfConductorsPerClient?: number; diff --git a/docs/tryorama.clientsplayersoptions.partialconfig.md b/docs/tryorama.clientsplayersoptions.partialconfig.md index 7269db51..80fb5243 100644 --- a/docs/tryorama.clientsplayersoptions.partialconfig.md +++ b/docs/tryorama.clientsplayersoptions.partialconfig.md @@ -6,7 +6,7 @@ Configuration for the conductor (optional). -Signature: +**Signature:** ```typescript partialConfig?: string; diff --git a/docs/tryorama.clientsplayersoptions.signalhandler.md b/docs/tryorama.clientsplayersoptions.signalhandler.md index 94e89dcc..483033b2 100644 --- a/docs/tryorama.clientsplayersoptions.signalhandler.md +++ b/docs/tryorama.clientsplayersoptions.signalhandler.md @@ -6,7 +6,7 @@ A signal handler to be registered in conductors. -Signature: +**Signature:** ```typescript signalHandler?: AppSignalCb; diff --git a/docs/tryorama.conductor.adminws.md b/docs/tryorama.conductor.adminws.md index 8087ddc7..3aaf3903 100644 --- a/docs/tryorama.conductor.adminws.md +++ b/docs/tryorama.conductor.adminws.md @@ -6,12 +6,12 @@ Get all Admin API methods. -Signature: +**Signature:** ```typescript adminWs(): AdminWebsocket; ``` -Returns: +**Returns:** AdminWebsocket diff --git a/docs/tryorama.conductor.attachappinterface.md b/docs/tryorama.conductor.attachappinterface.md index 0eb10094..0bd44cfb 100644 --- a/docs/tryorama.conductor.attachappinterface.md +++ b/docs/tryorama.conductor.attachappinterface.md @@ -6,7 +6,7 @@ Attach a web socket to the App API. -Signature: +**Signature:** ```typescript attachAppInterface(request?: AttachAppInterfaceRequest): Promise; @@ -16,9 +16,9 @@ attachAppInterface(request?: AttachAppInterfaceRequest): Promise; | Parameter | Type | Description | | --- | --- | --- | -| request | AttachAppInterfaceRequest | (Optional) Specify a port for the web socket (optional). | +| request | AttachAppInterfaceRequest | _(Optional)_ Specify a port for the web socket (optional). | -Returns: +**Returns:** Promise<number> diff --git a/docs/tryorama.conductor.connectappagentws.md b/docs/tryorama.conductor.connectappagentws.md index 11369a01..f4c7abf6 100644 --- a/docs/tryorama.conductor.connectappagentws.md +++ b/docs/tryorama.conductor.connectappagentws.md @@ -6,7 +6,7 @@ Connect a web socket for a specific app and agent to the App API, -Signature: +**Signature:** ```typescript connectAppAgentWs(port: number, appId: string): Promise; @@ -19,7 +19,7 @@ connectAppAgentWs(port: number, appId: string): Promise; | port | number | The websocket port to connect to. | | appId | string | The app id to make requests to. | -Returns: +**Returns:** Promise<AppAgentWebsocket> diff --git a/docs/tryorama.conductor.connectappws.md b/docs/tryorama.conductor.connectappws.md index d27459d9..a0425171 100644 --- a/docs/tryorama.conductor.connectappws.md +++ b/docs/tryorama.conductor.connectappws.md @@ -6,7 +6,7 @@ Connect a web socket to the App API, -Signature: +**Signature:** ```typescript connectAppWs(port: number): Promise; @@ -18,7 +18,7 @@ connectAppWs(port: number): Promise; | --- | --- | --- | | port | number | The websocket port to connect to. | -Returns: +**Returns:** Promise<AppWebsocket> diff --git a/docs/tryorama.conductor.create.md b/docs/tryorama.conductor.create.md index 275af3df..214bcb7c 100644 --- a/docs/tryorama.conductor.create.md +++ b/docs/tryorama.conductor.create.md @@ -6,7 +6,7 @@ Factory to create a conductor. -Signature: +**Signature:** ```typescript static create(signalingServerUrl: URL, options?: CreateConductorOptions): Promise; @@ -17,9 +17,9 @@ static create(signalingServerUrl: URL, options?: CreateConductorOptions): Promis | Parameter | Type | Description | | --- | --- | --- | | signalingServerUrl | URL | | -| options | [CreateConductorOptions](./tryorama.createconductoroptions.md) | (Optional) | +| options | [CreateConductorOptions](./tryorama.createconductoroptions.md) | _(Optional)_ | -Returns: +**Returns:** Promise<[Conductor](./tryorama.conductor.md)> diff --git a/docs/tryorama.conductor.gettmpdirectory.md b/docs/tryorama.conductor.gettmpdirectory.md index 4acc6927..9e1aaa80 100644 --- a/docs/tryorama.conductor.gettmpdirectory.md +++ b/docs/tryorama.conductor.gettmpdirectory.md @@ -6,12 +6,12 @@ Get the path of the directory that contains all files and folders of the conductor. -Signature: +**Signature:** ```typescript getTmpDirectory(): string; ``` -Returns: +**Returns:** string diff --git a/docs/tryorama.conductor.installagentsapps.md b/docs/tryorama.conductor.installagentsapps.md index 2152ae26..77a9cb17 100644 --- a/docs/tryorama.conductor.installagentsapps.md +++ b/docs/tryorama.conductor.installagentsapps.md @@ -6,7 +6,7 @@ Install an app for multiple agents into the conductor. -Signature: +**Signature:** ```typescript installAgentsApps(options: AgentsAppsOptions): Promise; @@ -18,7 +18,7 @@ installAgentsApps(options: AgentsAppsOptions): PromiseReturns: +**Returns:** Promise<import("@holochain/client").AppInfo\[\]> diff --git a/docs/tryorama.conductor.installapp.md b/docs/tryorama.conductor.installapp.md index afea9736..ef887e25 100644 --- a/docs/tryorama.conductor.installapp.md +++ b/docs/tryorama.conductor.installapp.md @@ -6,7 +6,7 @@ Install an application into the conductor. -Signature: +**Signature:** ```typescript installApp(appBundleSource: AppBundleSource, options?: AppOptions): Promise; @@ -17,9 +17,9 @@ installApp(appBundleSource: AppBundleSource, options?: AppOptions): Promise(Optional) [AppOptions](./tryorama.appoptions.md) for the hApp bundle (optional). | +| options | [AppOptions](./tryorama.appoptions.md) | _(Optional)_ [AppOptions](./tryorama.appoptions.md) for the hApp bundle (optional). | -Returns: +**Returns:** Promise<import("@holochain/client").AppInfo> diff --git a/docs/tryorama.conductor.md b/docs/tryorama.conductor.md index a9a741d9..3aa5e9eb 100644 --- a/docs/tryorama.conductor.md +++ b/docs/tryorama.conductor.md @@ -6,12 +6,12 @@ A class to manage a conductor running on localhost. -Signature: +**Signature:** ```typescript export declare class Conductor implements IConductor ``` -Implements: [IConductor](./tryorama.iconductor.md) +**Implements:** [IConductor](./tryorama.iconductor.md) ## Methods diff --git a/docs/tryorama.conductor.shutdown.md b/docs/tryorama.conductor.shutdown.md index 927bb1b6..4ca2d2d8 100644 --- a/docs/tryorama.conductor.shutdown.md +++ b/docs/tryorama.conductor.shutdown.md @@ -6,12 +6,12 @@ Close Admin and App API connections and kill the conductor process. -Signature: +**Signature:** ```typescript shutDown(): Promise; ``` -Returns: +**Returns:** Promise<number \| null> diff --git a/docs/tryorama.conductor.startup.md b/docs/tryorama.conductor.startup.md index f57d5871..2d41794d 100644 --- a/docs/tryorama.conductor.startup.md +++ b/docs/tryorama.conductor.startup.md @@ -6,12 +6,12 @@ Start the conductor and establish a web socket connection to the Admin API. -Signature: +**Signature:** ```typescript startUp(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.conductorcellsdhtsync.md b/docs/tryorama.conductorcellsdhtsync.md new file mode 100644 index 00000000..f6e27129 --- /dev/null +++ b/docs/tryorama.conductorcellsdhtsync.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [conductorCellsDhtSync](./tryorama.conductorcellsdhtsync.md) + +## conductorCellsDhtSync variable + +A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. + +**Signature:** + +```typescript +conductorCellsDhtSync: (conductorCells: IConductorCell[], interval?: number, timeout?: number) => Promise +``` diff --git a/docs/tryorama.conductorid.md b/docs/tryorama.conductorid.md index 58ca57ee..3a5ec443 100644 --- a/docs/tryorama.conductorid.md +++ b/docs/tryorama.conductorid.md @@ -5,7 +5,7 @@ ## ConductorId type -Signature: +**Signature:** ```typescript export type ConductorId = string; diff --git a/docs/tryorama.conductoroptions.bootstrapserverurl.md b/docs/tryorama.conductoroptions.bootstrapserverurl.md index 9d9d5bf3..fd7a5718 100644 --- a/docs/tryorama.conductoroptions.bootstrapserverurl.md +++ b/docs/tryorama.conductoroptions.bootstrapserverurl.md @@ -6,7 +6,7 @@ A bootstrap server URL for peers to discover each other. -Signature: +**Signature:** ```typescript bootstrapServerUrl?: URL; diff --git a/docs/tryorama.conductoroptions.md b/docs/tryorama.conductoroptions.md index 0412760f..529785ec 100644 --- a/docs/tryorama.conductoroptions.md +++ b/docs/tryorama.conductoroptions.md @@ -5,7 +5,7 @@ ## ConductorOptions interface -Signature: +**Signature:** ```typescript export interface ConductorOptions @@ -15,8 +15,8 @@ export interface ConductorOptions | 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. | +| [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.conductoroptions.networktype.md b/docs/tryorama.conductoroptions.networktype.md index 2a0248cf..d2a5a311 100644 --- a/docs/tryorama.conductoroptions.networktype.md +++ b/docs/tryorama.conductoroptions.networktype.md @@ -6,7 +6,7 @@ The network type the conductor should use. -Signature: +**Signature:** ```typescript networkType?: NetworkType; diff --git a/docs/tryorama.conductoroptions.startup.md b/docs/tryorama.conductoroptions.startup.md index f28dc9dc..c9841c35 100644 --- a/docs/tryorama.conductoroptions.startup.md +++ b/docs/tryorama.conductoroptions.startup.md @@ -6,7 +6,7 @@ Start up conductor after creation. -Signature: +**Signature:** ```typescript startup?: boolean; diff --git a/docs/tryorama.conductoroptions.timeout.md b/docs/tryorama.conductoroptions.timeout.md index 33929227..0d520aaf 100644 --- a/docs/tryorama.conductoroptions.timeout.md +++ b/docs/tryorama.conductoroptions.timeout.md @@ -6,7 +6,7 @@ Timeout for requests to Admin and App API. -Signature: +**Signature:** ```typescript timeout?: number; diff --git a/docs/tryorama.createconductor.md b/docs/tryorama.createconductor.md index c29ebb23..9a2995f2 100644 --- a/docs/tryorama.createconductor.md +++ b/docs/tryorama.createconductor.md @@ -6,7 +6,7 @@ The function to create a conductor. It starts a sandbox conductor via the Holochain CLI. -Signature: +**Signature:** ```typescript createConductor: (signalingServerUrl: URL, options?: ConductorOptions) => Promise diff --git a/docs/tryorama.createconductoroptions.md b/docs/tryorama.createconductoroptions.md index 5432eb04..306e913a 100644 --- a/docs/tryorama.createconductoroptions.md +++ b/docs/tryorama.createconductoroptions.md @@ -6,10 +6,10 @@ Options for using the conductor factory. -Signature: +**Signature:** ```typescript export type CreateConductorOptions = Pick; ``` -References: [ConductorOptions](./tryorama.conductoroptions.md) +**References:** [ConductorOptions](./tryorama.conductoroptions.md) diff --git a/docs/tryorama.createtrycpconductor.md b/docs/tryorama.createtrycpconductor.md index ca97bdb2..8bebd189 100644 --- a/docs/tryorama.createtrycpconductor.md +++ b/docs/tryorama.createtrycpconductor.md @@ -6,7 +6,7 @@ The function to create a TryCP Conductor. By default configures and starts it. -Signature: +**Signature:** ```typescript createTryCpConductor: (tryCpClient: TryCpClient, options?: TryCpConductorOptions) => Promise diff --git a/docs/tryorama.default_partial_player_config.md b/docs/tryorama.default_partial_player_config.md index a8f4d325..0b7f9aa7 100644 --- a/docs/tryorama.default_partial_player_config.md +++ b/docs/tryorama.default_partial_player_config.md @@ -6,7 +6,7 @@ The default partial config for a TryCP conductor. -Signature: +**Signature:** ```typescript DEFAULT_PARTIAL_PLAYER_CONFIG: string diff --git a/docs/tryorama.dhtsync.md b/docs/tryorama.dhtsync.md index 9330d877..b43e6eb3 100644 --- a/docs/tryorama.dhtsync.md +++ b/docs/tryorama.dhtsync.md @@ -6,7 +6,7 @@ A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. -Signature: +**Signature:** ```typescript dhtSync: (players: IPlayer[], dnaHash: DnaHash, interval?: number, timeout?: number) => Promise diff --git a/docs/tryorama.dna.md b/docs/tryorama.dna.md index 64106242..41bf9af1 100644 --- a/docs/tryorama.dna.md +++ b/docs/tryorama.dna.md @@ -6,7 +6,7 @@ DNA source and additional options. -Signature: +**Signature:** ```typescript export interface Dna @@ -16,8 +16,8 @@ export interface Dna | 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) | +| [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.dna.membraneproof.md b/docs/tryorama.dna.membraneproof.md index 71c4464a..ee0144f3 100644 --- a/docs/tryorama.dna.membraneproof.md +++ b/docs/tryorama.dna.membraneproof.md @@ -4,7 +4,7 @@ ## Dna.membraneProof property -Signature: +**Signature:** ```typescript membraneProof?: MembraneProof; diff --git a/docs/tryorama.dna.properties.md b/docs/tryorama.dna.properties.md index 2e43ecca..4ec7a798 100644 --- a/docs/tryorama.dna.properties.md +++ b/docs/tryorama.dna.properties.md @@ -4,7 +4,7 @@ ## Dna.properties property -Signature: +**Signature:** ```typescript properties?: DnaProperties; diff --git a/docs/tryorama.dna.rolename.md b/docs/tryorama.dna.rolename.md index 5e9fe441..4d5af5ca 100644 --- a/docs/tryorama.dna.rolename.md +++ b/docs/tryorama.dna.rolename.md @@ -4,7 +4,7 @@ ## Dna.roleName property -Signature: +**Signature:** ```typescript roleName?: string; diff --git a/docs/tryorama.dna.source.md b/docs/tryorama.dna.source.md index 8254df8f..e903ce84 100644 --- a/docs/tryorama.dna.source.md +++ b/docs/tryorama.dna.source.md @@ -4,7 +4,7 @@ ## Dna.source property -Signature: +**Signature:** ```typescript source: DnaSource; diff --git a/docs/tryorama.enableandgetagentapp.md b/docs/tryorama.enableandgetagentapp.md index 16409369..b06477df 100644 --- a/docs/tryorama.enableandgetagentapp.md +++ b/docs/tryorama.enableandgetagentapp.md @@ -6,7 +6,7 @@ Enable an app and build an agent app object. -Signature: +**Signature:** ```typescript enableAndGetAgentApp: (adminWs: IAdminWebsocket, appWs: IAppWebsocket | IAppAgentWebsocket, appInfo: AppInfo) => Promise diff --git a/docs/tryorama.getcallablecell.md b/docs/tryorama.getcallablecell.md index 3694b111..a9a96f24 100644 --- a/docs/tryorama.getcallablecell.md +++ b/docs/tryorama.getcallablecell.md @@ -6,7 +6,7 @@ Create curried version of `callZome` function for a specific cell. -Signature: +**Signature:** ```typescript getCallableCell: (appWs: IAppWebsocket | IAppAgentWebsocket, cell: ClonedCell | ProvisionedCell) => { diff --git a/docs/tryorama.getzomecaller.md b/docs/tryorama.getzomecaller.md index 2c064d16..4e279192 100644 --- a/docs/tryorama.getzomecaller.md +++ b/docs/tryorama.getzomecaller.md @@ -6,7 +6,7 @@ Get a shorthand function to call a cell's zome. -Signature: +**Signature:** ```typescript getZomeCaller: (cell: CallableCell, zomeName: string) => (fnName: string, payload?: unknown, timeout?: number) => Promise diff --git a/docs/tryorama.iadminwebsocket.md b/docs/tryorama.iadminwebsocket.md index e60ca2c4..e763c355 100644 --- a/docs/tryorama.iadminwebsocket.md +++ b/docs/tryorama.iadminwebsocket.md @@ -6,7 +6,7 @@ AdminWebsocket interface for local and TryCP conductors. -Signature: +**Signature:** ```typescript export type IAdminWebsocket = Omit; diff --git a/docs/tryorama.iappagentwebsocket.md b/docs/tryorama.iappagentwebsocket.md index 341301c4..dcebb55a 100644 --- a/docs/tryorama.iappagentwebsocket.md +++ b/docs/tryorama.iappagentwebsocket.md @@ -6,7 +6,7 @@ AppAgentWebsocket interface for local and TryCP conductors. -Signature: +**Signature:** ```typescript export type IAppAgentWebsocket = Pick; diff --git a/docs/tryorama.iappwebsocket.md b/docs/tryorama.iappwebsocket.md index 1fc237ad..0ded1865 100644 --- a/docs/tryorama.iappwebsocket.md +++ b/docs/tryorama.iappwebsocket.md @@ -6,7 +6,7 @@ AppWebsocket interface for local and TryCP conductors. -Signature: +**Signature:** ```typescript export type IAppWebsocket = Pick; diff --git a/docs/tryorama.iconductor.adminws.md b/docs/tryorama.iconductor.adminws.md index a312d069..b83dc297 100644 --- a/docs/tryorama.iconductor.adminws.md +++ b/docs/tryorama.iconductor.adminws.md @@ -4,7 +4,7 @@ ## IConductor.adminWs property -Signature: +**Signature:** ```typescript adminWs: () => IAdminWebsocket; diff --git a/docs/tryorama.iconductor.connectappagentws.md b/docs/tryorama.iconductor.connectappagentws.md index faf528df..1c384ccb 100644 --- a/docs/tryorama.iconductor.connectappagentws.md +++ b/docs/tryorama.iconductor.connectappagentws.md @@ -4,7 +4,7 @@ ## IConductor.connectAppAgentWs property -Signature: +**Signature:** ```typescript connectAppAgentWs: (port: number, appId: InstalledAppId) => Promise; diff --git a/docs/tryorama.iconductor.connectappws.md b/docs/tryorama.iconductor.connectappws.md index 6e8582c3..e36e0aac 100644 --- a/docs/tryorama.iconductor.connectappws.md +++ b/docs/tryorama.iconductor.connectappws.md @@ -4,7 +4,7 @@ ## IConductor.connectAppWs property -Signature: +**Signature:** ```typescript connectAppWs: (port: number) => Promise; diff --git a/docs/tryorama.iconductor.installagentsapps.md b/docs/tryorama.iconductor.installagentsapps.md index 9c6e94b0..e336f44a 100644 --- a/docs/tryorama.iconductor.installagentsapps.md +++ b/docs/tryorama.iconductor.installagentsapps.md @@ -4,7 +4,7 @@ ## IConductor.installAgentsApps property -Signature: +**Signature:** ```typescript installAgentsApps: (options: AgentsAppsOptions) => Promise; diff --git a/docs/tryorama.iconductor.installapp.md b/docs/tryorama.iconductor.installapp.md index 1a8917fd..a559f10d 100644 --- a/docs/tryorama.iconductor.installapp.md +++ b/docs/tryorama.iconductor.installapp.md @@ -4,7 +4,7 @@ ## IConductor.installApp property -Signature: +**Signature:** ```typescript installApp: (appBundleSource: AppBundleSource, options?: AppOptions) => Promise; diff --git a/docs/tryorama.iconductor.md b/docs/tryorama.iconductor.md index 8230f79f..1928d2c0 100644 --- a/docs/tryorama.iconductor.md +++ b/docs/tryorama.iconductor.md @@ -6,7 +6,7 @@ Base interface of a Tryorama conductor. Both [Conductor](./tryorama.conductor.md) and [TryCpConductor](./tryorama.trycpconductor.md) implement this interface. -Signature: +**Signature:** ```typescript export interface IConductor diff --git a/docs/tryorama.iconductor.shutdown.md b/docs/tryorama.iconductor.shutdown.md index 43fe8c1c..aba6d5ef 100644 --- a/docs/tryorama.iconductor.shutdown.md +++ b/docs/tryorama.iconductor.shutdown.md @@ -4,7 +4,7 @@ ## IConductor.shutDown property -Signature: +**Signature:** ```typescript shutDown: () => Promise; diff --git a/docs/tryorama.iconductor.startup.md b/docs/tryorama.iconductor.startup.md index dd596368..bfd49d59 100644 --- a/docs/tryorama.iconductor.startup.md +++ b/docs/tryorama.iconductor.startup.md @@ -4,7 +4,7 @@ ## IConductor.startUp property -Signature: +**Signature:** ```typescript startUp: () => Promise; diff --git a/docs/tryorama.iconductorcell.cellid.md b/docs/tryorama.iconductorcell.cellid.md new file mode 100644 index 00000000..576d262e --- /dev/null +++ b/docs/tryorama.iconductorcell.cellid.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [IConductorCell](./tryorama.iconductorcell.md) > [cellId](./tryorama.iconductorcell.cellid.md) + +## IConductorCell.cellId property + +**Signature:** + +```typescript +cellId: CellId; +``` diff --git a/docs/tryorama.iconductorcell.conductor.md b/docs/tryorama.iconductorcell.conductor.md new file mode 100644 index 00000000..7f57b8c4 --- /dev/null +++ b/docs/tryorama.iconductorcell.conductor.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [IConductorCell](./tryorama.iconductorcell.md) > [conductor](./tryorama.iconductorcell.conductor.md) + +## IConductorCell.conductor property + +**Signature:** + +```typescript +conductor: IConductor; +``` diff --git a/docs/tryorama.iconductorcell.md b/docs/tryorama.iconductorcell.md new file mode 100644 index 00000000..f67cded0 --- /dev/null +++ b/docs/tryorama.iconductorcell.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [IConductorCell](./tryorama.iconductorcell.md) + +## IConductorCell interface + +A Conductor and a CellId + +**Signature:** + +```typescript +export interface IConductorCell +``` + +## Properties + +| 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.appagentws.md b/docs/tryorama.iplayer.appagentws.md index a755d16f..5aa076bd 100644 --- a/docs/tryorama.iplayer.appagentws.md +++ b/docs/tryorama.iplayer.appagentws.md @@ -4,7 +4,7 @@ ## IPlayer.appAgentWs property -Signature: +**Signature:** ```typescript appAgentWs: AppAgentWebsocket | IAppAgentWebsocket; diff --git a/docs/tryorama.iplayer.conductor.md b/docs/tryorama.iplayer.conductor.md index f75186f6..f6ddf4af 100644 --- a/docs/tryorama.iplayer.conductor.md +++ b/docs/tryorama.iplayer.conductor.md @@ -4,7 +4,7 @@ ## IPlayer.conductor property -Signature: +**Signature:** ```typescript conductor: IConductor; diff --git a/docs/tryorama.iplayer.md b/docs/tryorama.iplayer.md index 0db38f24..fa8e6cb2 100644 --- a/docs/tryorama.iplayer.md +++ b/docs/tryorama.iplayer.md @@ -6,12 +6,12 @@ Combines an agent hApp with the conductor they belong to. -Signature: +**Signature:** ```typescript export interface IPlayer extends AgentApp ``` -Extends: [AgentApp](./tryorama.agentapp.md) +**Extends:** [AgentApp](./tryorama.agentapp.md) ## Properties diff --git a/docs/tryorama.md b/docs/tryorama.md index 691852f9..a212b842 100644 --- a/docs/tryorama.md +++ b/docs/tryorama.md @@ -69,6 +69,7 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r | [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. | @@ -99,8 +100,10 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r | Variable | Description | | --- | --- | | [addAllAgentsToAllConductors](./tryorama.addallagentstoallconductors.md) | Add all agents of all conductors to each other. Shortcuts peer discovery through a bootstrap server or gossiping. | +| [areConductorCellsDhtsSynced](./tryorama.areconductorcellsdhtssynced.md) | A utility function to compare conductors' integrated DhtOps. | | [areDhtsSynced](./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](./tryorama.conductorcellsdhtsync.md) | A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. | | [createConductor](./tryorama.createconductor.md) | The function to create a conductor. It starts a sandbox conductor via the Holochain CLI. | | [createTryCpConductor](./tryorama.createtrycpconductor.md) | The function to create a TryCP Conductor. By default configures and starts it. | | [DEFAULT\_PARTIAL\_PLAYER\_CONFIG](./tryorama.default_partial_player_config.md) | The default partial config for a TryCP conductor. | diff --git a/docs/tryorama.networktype.md b/docs/tryorama.networktype.md index 445ba2c7..a852d922 100644 --- a/docs/tryorama.networktype.md +++ b/docs/tryorama.networktype.md @@ -6,7 +6,7 @@ The network type the conductor should use to communicate with peers. -Signature: +**Signature:** ```typescript export declare enum NetworkType diff --git a/docs/tryorama.pause.md b/docs/tryorama.pause.md index bb289793..aa04b95e 100644 --- a/docs/tryorama.pause.md +++ b/docs/tryorama.pause.md @@ -6,7 +6,7 @@ A utility function to wait the given amount of time. -Signature: +**Signature:** ```typescript pause: (milliseconds: number) => Promise diff --git a/docs/tryorama.player.conductor.md b/docs/tryorama.player.conductor.md index c94f7135..ce5b2940 100644 --- a/docs/tryorama.player.conductor.md +++ b/docs/tryorama.player.conductor.md @@ -4,7 +4,7 @@ ## Player.conductor property -Signature: +**Signature:** ```typescript conductor: Conductor; diff --git a/docs/tryorama.player.md b/docs/tryorama.player.md index ea724a3f..5a5de42e 100644 --- a/docs/tryorama.player.md +++ b/docs/tryorama.player.md @@ -6,12 +6,12 @@ A player tied to a [Conductor](./tryorama.conductor.md). -Signature: +**Signature:** ```typescript export interface Player extends IPlayer ``` -Extends: [IPlayer](./tryorama.iplayer.md) +**Extends:** [IPlayer](./tryorama.iplayer.md) ## Properties diff --git a/docs/tryorama.requestadmininterfacemessage.data.md b/docs/tryorama.requestadmininterfacemessage.data.md index 0fb4e710..a2d7d9ec 100644 --- a/docs/tryorama.requestadmininterfacemessage.data.md +++ b/docs/tryorama.requestadmininterfacemessage.data.md @@ -4,7 +4,7 @@ ## RequestAdminInterfaceMessage.data property -Signature: +**Signature:** ```typescript data?: AddAgentInfoRequest | AgentInfoRequest | AttachAppInterfaceRequest | DeleteCloneCellRequest | DisableAppRequest | DumpFullStateRequest | DumpNetworkStatsRequest | DumpStateRequest | EnableAppRequest | GetDnaDefinitionRequest | GrantZomeCallCapabilityRequest | InstallAppRequest | ListAppsRequest | RegisterDnaRequest | StartAppRequest | StorageInfoRequest | UninstallAppRequest | UpdateCoordinatorsRequest; diff --git a/docs/tryorama.requestadmininterfacemessage.md b/docs/tryorama.requestadmininterfacemessage.md index 5a6781cc..c6224bb0 100644 --- a/docs/tryorama.requestadmininterfacemessage.md +++ b/docs/tryorama.requestadmininterfacemessage.md @@ -6,7 +6,7 @@ All possible calls to the Admin API. -Signature: +**Signature:** ```typescript export interface RequestAdminInterfaceMessage @@ -16,6 +16,6 @@ export interface RequestAdminInterfaceMessage | 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) | +| [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.requestadmininterfacemessage.type.md b/docs/tryorama.requestadmininterfacemessage.type.md index 4b48487c..f86d5391 100644 --- a/docs/tryorama.requestadmininterfacemessage.type.md +++ b/docs/tryorama.requestadmininterfacemessage.type.md @@ -4,7 +4,7 @@ ## RequestAdminInterfaceMessage.type property -Signature: +**Signature:** ```typescript type: "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.data.md b/docs/tryorama.requestappinfo.data.md index 550a60f7..93892573 100644 --- a/docs/tryorama.requestappinfo.data.md +++ b/docs/tryorama.requestappinfo.data.md @@ -4,7 +4,7 @@ ## RequestAppInfo.data property -Signature: +**Signature:** ```typescript data: { diff --git a/docs/tryorama.requestappinfo.md b/docs/tryorama.requestappinfo.md index d9b2bee2..696365e8 100644 --- a/docs/tryorama.requestappinfo.md +++ b/docs/tryorama.requestappinfo.md @@ -6,7 +6,7 @@ Request app info from a conductor. -Signature: +**Signature:** ```typescript export interface RequestAppInfo diff --git a/docs/tryorama.requestappinfo.type.md b/docs/tryorama.requestappinfo.type.md index dcdcbe00..c2d0255b 100644 --- a/docs/tryorama.requestappinfo.type.md +++ b/docs/tryorama.requestappinfo.type.md @@ -4,7 +4,7 @@ ## RequestAppInfo.type property -Signature: +**Signature:** ```typescript type: "app_info"; diff --git a/docs/tryorama.requestcalladmininterface.id.md b/docs/tryorama.requestcalladmininterface.id.md index 26129930..9cfc2a9a 100644 --- a/docs/tryorama.requestcalladmininterface.id.md +++ b/docs/tryorama.requestcalladmininterface.id.md @@ -4,7 +4,7 @@ ## RequestCallAdminInterface.id property -Signature: +**Signature:** ```typescript id: ConductorId; diff --git a/docs/tryorama.requestcalladmininterface.md b/docs/tryorama.requestcalladmininterface.md index 5570c254..e78f8f5f 100644 --- a/docs/tryorama.requestcalladmininterface.md +++ b/docs/tryorama.requestcalladmininterface.md @@ -6,7 +6,7 @@ Request a call to the Admin API. -Signature: +**Signature:** ```typescript export interface RequestCallAdminInterface diff --git a/docs/tryorama.requestcalladmininterface.message.md b/docs/tryorama.requestcalladmininterface.message.md index c75d375c..3e998812 100644 --- a/docs/tryorama.requestcalladmininterface.message.md +++ b/docs/tryorama.requestcalladmininterface.message.md @@ -4,7 +4,7 @@ ## RequestCallAdminInterface.message property -Signature: +**Signature:** ```typescript message: RequestAdminInterfaceMessage; diff --git a/docs/tryorama.requestcalladmininterface.type.md b/docs/tryorama.requestcalladmininterface.type.md index add51eac..b1398c1b 100644 --- a/docs/tryorama.requestcalladmininterface.type.md +++ b/docs/tryorama.requestcalladmininterface.type.md @@ -4,7 +4,7 @@ ## RequestCallAdminInterface.type property -Signature: +**Signature:** ```typescript type: "call_admin_interface"; diff --git a/docs/tryorama.requestcallappinterface.md b/docs/tryorama.requestcallappinterface.md index f682469c..9accfb24 100644 --- a/docs/tryorama.requestcallappinterface.md +++ b/docs/tryorama.requestcallappinterface.md @@ -6,7 +6,7 @@ Request a call to the App API. -Signature: +**Signature:** ```typescript export interface RequestCallAppInterface diff --git a/docs/tryorama.requestcallappinterface.message.md b/docs/tryorama.requestcallappinterface.message.md index c605b28f..8f8ffa70 100644 --- a/docs/tryorama.requestcallappinterface.message.md +++ b/docs/tryorama.requestcallappinterface.message.md @@ -4,7 +4,7 @@ ## RequestCallAppInterface.message property -Signature: +**Signature:** ```typescript message: RequestCallAppInterfaceMessage; diff --git a/docs/tryorama.requestcallappinterface.port.md b/docs/tryorama.requestcallappinterface.port.md index bef220e8..5ce9ed97 100644 --- a/docs/tryorama.requestcallappinterface.port.md +++ b/docs/tryorama.requestcallappinterface.port.md @@ -4,7 +4,7 @@ ## RequestCallAppInterface.port property -Signature: +**Signature:** ```typescript port: number; diff --git a/docs/tryorama.requestcallappinterface.type.md b/docs/tryorama.requestcallappinterface.type.md index 14c81dfd..5642693e 100644 --- a/docs/tryorama.requestcallappinterface.type.md +++ b/docs/tryorama.requestcallappinterface.type.md @@ -4,7 +4,7 @@ ## RequestCallAppInterface.type property -Signature: +**Signature:** ```typescript type: "call_app_interface"; diff --git a/docs/tryorama.requestcallappinterfaceencoded.md b/docs/tryorama.requestcallappinterfaceencoded.md index d7c89422..5d6960ae 100644 --- a/docs/tryorama.requestcallappinterfaceencoded.md +++ b/docs/tryorama.requestcallappinterfaceencoded.md @@ -6,12 +6,12 @@ Msgpack encoded request to call an app interface. -Signature: +**Signature:** ```typescript export interface RequestCallAppInterfaceEncoded extends Omit ``` -Extends: Omit<[RequestCallAppInterface](./tryorama.requestcallappinterface.md), "message"> +**Extends:** Omit<[RequestCallAppInterface](./tryorama.requestcallappinterface.md), "message"> ## Properties diff --git a/docs/tryorama.requestcallappinterfaceencoded.message.md b/docs/tryorama.requestcallappinterfaceencoded.message.md index 75ba6f7e..db455a96 100644 --- a/docs/tryorama.requestcallappinterfaceencoded.message.md +++ b/docs/tryorama.requestcallappinterfaceencoded.message.md @@ -4,7 +4,7 @@ ## RequestCallAppInterfaceEncoded.message property -Signature: +**Signature:** ```typescript message: Uint8Array; diff --git a/docs/tryorama.requestcallappinterfacemessage.md b/docs/tryorama.requestcallappinterfacemessage.md index 8c6117a4..c4555891 100644 --- a/docs/tryorama.requestcallappinterfacemessage.md +++ b/docs/tryorama.requestcallappinterfacemessage.md @@ -6,10 +6,10 @@ All possible calls to the App API. -Signature: +**Signature:** ```typescript export type RequestCallAppInterfaceMessage = RequestCallZome | RequestAppInfo | RequestCreateCloneCell | RequestEnableCloneCell | RequestDisableCloneCell | RequestNetworkInfo; ``` -References: [RequestCallZome](./tryorama.requestcallzome.md), [RequestAppInfo](./tryorama.requestappinfo.md), [RequestCreateCloneCell](./tryorama.requestcreateclonecell.md), [RequestEnableCloneCell](./tryorama.requestenableclonecell.md), [RequestDisableCloneCell](./tryorama.requestdisableclonecell.md), [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) +**References:** [RequestCallZome](./tryorama.requestcallzome.md), [RequestAppInfo](./tryorama.requestappinfo.md), [RequestCreateCloneCell](./tryorama.requestcreateclonecell.md), [RequestEnableCloneCell](./tryorama.requestenableclonecell.md), [RequestDisableCloneCell](./tryorama.requestdisableclonecell.md), [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) diff --git a/docs/tryorama.requestcallzome.data.md b/docs/tryorama.requestcallzome.data.md index 245374a7..bbd61cd9 100644 --- a/docs/tryorama.requestcallzome.data.md +++ b/docs/tryorama.requestcallzome.data.md @@ -4,7 +4,7 @@ ## RequestCallZome.data property -Signature: +**Signature:** ```typescript data: CallZomeRequestSigned; diff --git a/docs/tryorama.requestcallzome.md b/docs/tryorama.requestcallzome.md index 30a62839..6df5cb7f 100644 --- a/docs/tryorama.requestcallzome.md +++ b/docs/tryorama.requestcallzome.md @@ -6,7 +6,7 @@ Request to call a zome on a conductor's app interface. -Signature: +**Signature:** ```typescript export interface RequestCallZome diff --git a/docs/tryorama.requestcallzome.type.md b/docs/tryorama.requestcallzome.type.md index 1980eef8..cc7ca9c9 100644 --- a/docs/tryorama.requestcallzome.type.md +++ b/docs/tryorama.requestcallzome.type.md @@ -4,7 +4,7 @@ ## RequestCallZome.type property -Signature: +**Signature:** ```typescript type: "call_zome"; diff --git a/docs/tryorama.requestconfigureplayer.id.md b/docs/tryorama.requestconfigureplayer.id.md index d7482342..cfa90d11 100644 --- a/docs/tryorama.requestconfigureplayer.id.md +++ b/docs/tryorama.requestconfigureplayer.id.md @@ -4,7 +4,7 @@ ## RequestConfigurePlayer.id property -Signature: +**Signature:** ```typescript id: ConductorId; diff --git a/docs/tryorama.requestconfigureplayer.md b/docs/tryorama.requestconfigureplayer.md index e276cada..5ec67f93 100644 --- a/docs/tryorama.requestconfigureplayer.md +++ b/docs/tryorama.requestconfigureplayer.md @@ -6,7 +6,7 @@ Request to create configuration files and directories for a conductor. -Signature: +**Signature:** ```typescript export interface RequestConfigurePlayer diff --git a/docs/tryorama.requestconfigureplayer.partial_config.md b/docs/tryorama.requestconfigureplayer.partial_config.md index 3734f7a9..d763ace7 100644 --- a/docs/tryorama.requestconfigureplayer.partial_config.md +++ b/docs/tryorama.requestconfigureplayer.partial_config.md @@ -4,7 +4,7 @@ ## RequestConfigurePlayer.partial\_config property -Signature: +**Signature:** ```typescript partial_config: string; diff --git a/docs/tryorama.requestconfigureplayer.type.md b/docs/tryorama.requestconfigureplayer.type.md index 94ee3b72..82e19460 100644 --- a/docs/tryorama.requestconfigureplayer.type.md +++ b/docs/tryorama.requestconfigureplayer.type.md @@ -4,7 +4,7 @@ ## RequestConfigurePlayer.type property -Signature: +**Signature:** ```typescript type: "configure_player"; diff --git a/docs/tryorama.requestconnectappinterface.md b/docs/tryorama.requestconnectappinterface.md index 3efee1e0..a9a26ebf 100644 --- a/docs/tryorama.requestconnectappinterface.md +++ b/docs/tryorama.requestconnectappinterface.md @@ -6,7 +6,7 @@ Request to connect an app interface to a conductor. -Signature: +**Signature:** ```typescript export interface RequestConnectAppInterface diff --git a/docs/tryorama.requestconnectappinterface.port.md b/docs/tryorama.requestconnectappinterface.port.md index 823f08e6..a42830e2 100644 --- a/docs/tryorama.requestconnectappinterface.port.md +++ b/docs/tryorama.requestconnectappinterface.port.md @@ -4,7 +4,7 @@ ## RequestConnectAppInterface.port property -Signature: +**Signature:** ```typescript port: number; diff --git a/docs/tryorama.requestconnectappinterface.type.md b/docs/tryorama.requestconnectappinterface.type.md index 13a5c1a7..2e85fe47 100644 --- a/docs/tryorama.requestconnectappinterface.type.md +++ b/docs/tryorama.requestconnectappinterface.type.md @@ -4,7 +4,7 @@ ## RequestConnectAppInterface.type property -Signature: +**Signature:** ```typescript type: "connect_app_interface"; diff --git a/docs/tryorama.requestcreateclonecell.data.md b/docs/tryorama.requestcreateclonecell.data.md index 9026a368..7d2d2273 100644 --- a/docs/tryorama.requestcreateclonecell.data.md +++ b/docs/tryorama.requestcreateclonecell.data.md @@ -4,7 +4,7 @@ ## RequestCreateCloneCell.data property -Signature: +**Signature:** ```typescript data: CreateCloneCellRequest; diff --git a/docs/tryorama.requestcreateclonecell.md b/docs/tryorama.requestcreateclonecell.md index b30200b6..971a1d65 100644 --- a/docs/tryorama.requestcreateclonecell.md +++ b/docs/tryorama.requestcreateclonecell.md @@ -6,7 +6,7 @@ Create a clone cell. -Signature: +**Signature:** ```typescript export interface RequestCreateCloneCell diff --git a/docs/tryorama.requestcreateclonecell.type.md b/docs/tryorama.requestcreateclonecell.type.md index c2b2f4ef..9618efdf 100644 --- a/docs/tryorama.requestcreateclonecell.type.md +++ b/docs/tryorama.requestcreateclonecell.type.md @@ -4,7 +4,7 @@ ## RequestCreateCloneCell.type property -Signature: +**Signature:** ```typescript type: "create_clone_cell"; diff --git a/docs/tryorama.requestdeleteclonecell.data.md b/docs/tryorama.requestdeleteclonecell.data.md index faf58991..1c51a078 100644 --- a/docs/tryorama.requestdeleteclonecell.data.md +++ b/docs/tryorama.requestdeleteclonecell.data.md @@ -4,7 +4,7 @@ ## RequestDeleteCloneCell.data property -Signature: +**Signature:** ```typescript data: DeleteCloneCellRequest; diff --git a/docs/tryorama.requestdeleteclonecell.md b/docs/tryorama.requestdeleteclonecell.md index a52eed38..50908d76 100644 --- a/docs/tryorama.requestdeleteclonecell.md +++ b/docs/tryorama.requestdeleteclonecell.md @@ -6,7 +6,7 @@ Delete a disabled clone cell. -Signature: +**Signature:** ```typescript export interface RequestDeleteCloneCell diff --git a/docs/tryorama.requestdeleteclonecell.type.md b/docs/tryorama.requestdeleteclonecell.type.md index 49d60720..5d121db7 100644 --- a/docs/tryorama.requestdeleteclonecell.type.md +++ b/docs/tryorama.requestdeleteclonecell.type.md @@ -4,7 +4,7 @@ ## RequestDeleteCloneCell.type property -Signature: +**Signature:** ```typescript type: "delete_clone_cell"; diff --git a/docs/tryorama.requestdisableclonecell.data.md b/docs/tryorama.requestdisableclonecell.data.md index 9ccaf990..7ea3ffc0 100644 --- a/docs/tryorama.requestdisableclonecell.data.md +++ b/docs/tryorama.requestdisableclonecell.data.md @@ -4,7 +4,7 @@ ## RequestDisableCloneCell.data property -Signature: +**Signature:** ```typescript data: DisableCloneCellRequest; diff --git a/docs/tryorama.requestdisableclonecell.md b/docs/tryorama.requestdisableclonecell.md index 976b57c9..87a27027 100644 --- a/docs/tryorama.requestdisableclonecell.md +++ b/docs/tryorama.requestdisableclonecell.md @@ -6,7 +6,7 @@ Disable a clone cell. -Signature: +**Signature:** ```typescript export interface RequestDisableCloneCell diff --git a/docs/tryorama.requestdisableclonecell.type.md b/docs/tryorama.requestdisableclonecell.type.md index cda1f648..cb30c026 100644 --- a/docs/tryorama.requestdisableclonecell.type.md +++ b/docs/tryorama.requestdisableclonecell.type.md @@ -4,7 +4,7 @@ ## RequestDisableCloneCell.type property -Signature: +**Signature:** ```typescript type: "disable_clone_cell"; diff --git a/docs/tryorama.requestdisconnectappinterface.md b/docs/tryorama.requestdisconnectappinterface.md index d1838a33..f40118ea 100644 --- a/docs/tryorama.requestdisconnectappinterface.md +++ b/docs/tryorama.requestdisconnectappinterface.md @@ -6,7 +6,7 @@ Request to disconnect a connected app interface from a conductor. -Signature: +**Signature:** ```typescript export interface RequestDisconnectAppInterface diff --git a/docs/tryorama.requestdisconnectappinterface.port.md b/docs/tryorama.requestdisconnectappinterface.port.md index 4803be05..5af971b7 100644 --- a/docs/tryorama.requestdisconnectappinterface.port.md +++ b/docs/tryorama.requestdisconnectappinterface.port.md @@ -4,7 +4,7 @@ ## RequestDisconnectAppInterface.port property -Signature: +**Signature:** ```typescript port: number; diff --git a/docs/tryorama.requestdisconnectappinterface.type.md b/docs/tryorama.requestdisconnectappinterface.type.md index a4ad121f..23350ca5 100644 --- a/docs/tryorama.requestdisconnectappinterface.type.md +++ b/docs/tryorama.requestdisconnectappinterface.type.md @@ -4,7 +4,7 @@ ## RequestDisconnectAppInterface.type property -Signature: +**Signature:** ```typescript type: "disconnect_app_interface"; diff --git a/docs/tryorama.requestdownloaddna.md b/docs/tryorama.requestdownloaddna.md index 62be5f14..5fd1e847 100644 --- a/docs/tryorama.requestdownloaddna.md +++ b/docs/tryorama.requestdownloaddna.md @@ -6,7 +6,7 @@ Request to download a DNA from a URL. -Signature: +**Signature:** ```typescript export interface RequestDownloadDna diff --git a/docs/tryorama.requestdownloaddna.type.md b/docs/tryorama.requestdownloaddna.type.md index 9a878846..d53775ee 100644 --- a/docs/tryorama.requestdownloaddna.type.md +++ b/docs/tryorama.requestdownloaddna.type.md @@ -4,7 +4,7 @@ ## RequestDownloadDna.type property -Signature: +**Signature:** ```typescript type: "download_dna"; diff --git a/docs/tryorama.requestdownloaddna.url.md b/docs/tryorama.requestdownloaddna.url.md index 20fcaa43..e32c04b6 100644 --- a/docs/tryorama.requestdownloaddna.url.md +++ b/docs/tryorama.requestdownloaddna.url.md @@ -4,7 +4,7 @@ ## RequestDownloadDna.url property -Signature: +**Signature:** ```typescript url: string; diff --git a/docs/tryorama.requestenableclonecell.data.md b/docs/tryorama.requestenableclonecell.data.md index 833995a2..864477e4 100644 --- a/docs/tryorama.requestenableclonecell.data.md +++ b/docs/tryorama.requestenableclonecell.data.md @@ -4,7 +4,7 @@ ## RequestEnableCloneCell.data property -Signature: +**Signature:** ```typescript data: EnableCloneCellRequest; diff --git a/docs/tryorama.requestenableclonecell.md b/docs/tryorama.requestenableclonecell.md index 1c799f35..49af9ade 100644 --- a/docs/tryorama.requestenableclonecell.md +++ b/docs/tryorama.requestenableclonecell.md @@ -6,7 +6,7 @@ Enable a disabled clone cell. -Signature: +**Signature:** ```typescript export interface RequestEnableCloneCell diff --git a/docs/tryorama.requestenableclonecell.type.md b/docs/tryorama.requestenableclonecell.type.md index cd476645..33605716 100644 --- a/docs/tryorama.requestenableclonecell.type.md +++ b/docs/tryorama.requestenableclonecell.type.md @@ -4,7 +4,7 @@ ## RequestEnableCloneCell.type property -Signature: +**Signature:** ```typescript type: "enable_clone_cell"; diff --git a/docs/tryorama.requestnetworkinfo.data.md b/docs/tryorama.requestnetworkinfo.data.md index 954c29f1..d0ba2195 100644 --- a/docs/tryorama.requestnetworkinfo.data.md +++ b/docs/tryorama.requestnetworkinfo.data.md @@ -4,7 +4,7 @@ ## RequestNetworkInfo.data property -Signature: +**Signature:** ```typescript data: NetworkInfoRequest; diff --git a/docs/tryorama.requestnetworkinfo.md b/docs/tryorama.requestnetworkinfo.md index b3d8c532..0240c257 100644 --- a/docs/tryorama.requestnetworkinfo.md +++ b/docs/tryorama.requestnetworkinfo.md @@ -6,7 +6,7 @@ Request network info. -Signature: +**Signature:** ```typescript export interface RequestNetworkInfo diff --git a/docs/tryorama.requestnetworkinfo.type.md b/docs/tryorama.requestnetworkinfo.type.md index 1fa1f15d..97b9eafe 100644 --- a/docs/tryorama.requestnetworkinfo.type.md +++ b/docs/tryorama.requestnetworkinfo.type.md @@ -4,7 +4,7 @@ ## RequestNetworkInfo.type property -Signature: +**Signature:** ```typescript type: "network_info"; diff --git a/docs/tryorama.requestreset.md b/docs/tryorama.requestreset.md index fb672747..62b22233 100644 --- a/docs/tryorama.requestreset.md +++ b/docs/tryorama.requestreset.md @@ -6,7 +6,7 @@ Request deletion of \*\*all\*\* conductors. -Signature: +**Signature:** ```typescript export interface RequestReset diff --git a/docs/tryorama.requestreset.type.md b/docs/tryorama.requestreset.type.md index f8f56c29..37fb407a 100644 --- a/docs/tryorama.requestreset.type.md +++ b/docs/tryorama.requestreset.type.md @@ -4,7 +4,7 @@ ## RequestReset.type property -Signature: +**Signature:** ```typescript type: "reset"; diff --git a/docs/tryorama.requestsavedna.content.md b/docs/tryorama.requestsavedna.content.md index c35f3533..9356b071 100644 --- a/docs/tryorama.requestsavedna.content.md +++ b/docs/tryorama.requestsavedna.content.md @@ -4,7 +4,7 @@ ## RequestSaveDna.content property -Signature: +**Signature:** ```typescript content: Buffer; diff --git a/docs/tryorama.requestsavedna.id.md b/docs/tryorama.requestsavedna.id.md index 47b1f3d7..a2f09a94 100644 --- a/docs/tryorama.requestsavedna.id.md +++ b/docs/tryorama.requestsavedna.id.md @@ -4,7 +4,7 @@ ## RequestSaveDna.id property -Signature: +**Signature:** ```typescript id: string; diff --git a/docs/tryorama.requestsavedna.md b/docs/tryorama.requestsavedna.md index b3afe418..f23d64df 100644 --- a/docs/tryorama.requestsavedna.md +++ b/docs/tryorama.requestsavedna.md @@ -6,7 +6,7 @@ Request to save a DNA to the server's file system. -Signature: +**Signature:** ```typescript export interface RequestSaveDna diff --git a/docs/tryorama.requestsavedna.type.md b/docs/tryorama.requestsavedna.type.md index 0ba68e23..a814fed1 100644 --- a/docs/tryorama.requestsavedna.type.md +++ b/docs/tryorama.requestsavedna.type.md @@ -4,7 +4,7 @@ ## RequestSaveDna.type property -Signature: +**Signature:** ```typescript type: "save_dna"; diff --git a/docs/tryorama.requestshutdown.id.md b/docs/tryorama.requestshutdown.id.md index a14653c9..a631f79f 100644 --- a/docs/tryorama.requestshutdown.id.md +++ b/docs/tryorama.requestshutdown.id.md @@ -4,7 +4,7 @@ ## RequestShutdown.id property -Signature: +**Signature:** ```typescript id: ConductorId; diff --git a/docs/tryorama.requestshutdown.md b/docs/tryorama.requestshutdown.md index 9c97e1a2..7380c9ca 100644 --- a/docs/tryorama.requestshutdown.md +++ b/docs/tryorama.requestshutdown.md @@ -6,7 +6,7 @@ Request shutdown of a conductor. -Signature: +**Signature:** ```typescript export interface RequestShutdown @@ -17,6 +17,6 @@ export interface RequestShutdown | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [id](./tryorama.requestshutdown.id.md) | | [ConductorId](./tryorama.conductorid.md) | | -| [signal?](./tryorama.requestshutdown.signal.md) | | "SIGTERM" \| "SIGKILL" \| "SIGINT" | (Optional) | +| [signal?](./tryorama.requestshutdown.signal.md) | | "SIGTERM" \| "SIGKILL" \| "SIGINT" | _(Optional)_ | | [type](./tryorama.requestshutdown.type.md) | | "shutdown" | | diff --git a/docs/tryorama.requestshutdown.signal.md b/docs/tryorama.requestshutdown.signal.md index 0671037d..50a34547 100644 --- a/docs/tryorama.requestshutdown.signal.md +++ b/docs/tryorama.requestshutdown.signal.md @@ -4,7 +4,7 @@ ## RequestShutdown.signal property -Signature: +**Signature:** ```typescript signal?: "SIGTERM" | "SIGKILL" | "SIGINT"; diff --git a/docs/tryorama.requestshutdown.type.md b/docs/tryorama.requestshutdown.type.md index 4ade74fe..d6dcab44 100644 --- a/docs/tryorama.requestshutdown.type.md +++ b/docs/tryorama.requestshutdown.type.md @@ -4,7 +4,7 @@ ## RequestShutdown.type property -Signature: +**Signature:** ```typescript type: "shutdown"; diff --git a/docs/tryorama.requeststartup.id.md b/docs/tryorama.requeststartup.id.md index 870f2385..b7024854 100644 --- a/docs/tryorama.requeststartup.id.md +++ b/docs/tryorama.requeststartup.id.md @@ -4,7 +4,7 @@ ## RequestStartup.id property -Signature: +**Signature:** ```typescript id: ConductorId; diff --git a/docs/tryorama.requeststartup.log_level.md b/docs/tryorama.requeststartup.log_level.md index 93978e3e..bef44ccc 100644 --- a/docs/tryorama.requeststartup.log_level.md +++ b/docs/tryorama.requeststartup.log_level.md @@ -4,7 +4,7 @@ ## RequestStartup.log\_level property -Signature: +**Signature:** ```typescript log_level?: TryCpConductorLogLevel; diff --git a/docs/tryorama.requeststartup.md b/docs/tryorama.requeststartup.md index e5911d3a..81e85fe4 100644 --- a/docs/tryorama.requeststartup.md +++ b/docs/tryorama.requeststartup.md @@ -6,7 +6,7 @@ Request startup of a conductor. -Signature: +**Signature:** ```typescript export interface RequestStartup @@ -17,6 +17,6 @@ export interface RequestStartup | 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) | +| [log\_level?](./tryorama.requeststartup.log_level.md) | | [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md) | _(Optional)_ | | [type](./tryorama.requeststartup.type.md) | | "startup" | | diff --git a/docs/tryorama.requeststartup.type.md b/docs/tryorama.requeststartup.type.md index 211058a3..fc6a667c 100644 --- a/docs/tryorama.requeststartup.type.md +++ b/docs/tryorama.requeststartup.type.md @@ -4,7 +4,7 @@ ## RequestStartup.type property -Signature: +**Signature:** ```typescript type: "startup"; diff --git a/docs/tryorama.runlocalservices.md b/docs/tryorama.runlocalservices.md index 08ae4858..cfc5634d 100644 --- a/docs/tryorama.runlocalservices.md +++ b/docs/tryorama.runlocalservices.md @@ -6,7 +6,7 @@ Spawn a signalling server to enable connections between conductors. -Signature: +**Signature:** ```typescript runLocalServices: () => Promise<{ diff --git a/docs/tryorama.runscenario.md b/docs/tryorama.runscenario.md index 7e6385fd..28260e97 100644 --- a/docs/tryorama.runscenario.md +++ b/docs/tryorama.runscenario.md @@ -6,7 +6,7 @@ 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. -Signature: +**Signature:** ```typescript runScenario: (testScenario: (scenario: Scenario) => Promise, cleanUp?: boolean, options?: ScenarioOptions) => Promise diff --git a/docs/tryorama.scenario._constructor_.md b/docs/tryorama.scenario._constructor_.md index 0e53081b..a72d6009 100644 --- a/docs/tryorama.scenario._constructor_.md +++ b/docs/tryorama.scenario._constructor_.md @@ -6,7 +6,7 @@ Scenario constructor. -Signature: +**Signature:** ```typescript constructor(options?: ScenarioOptions); @@ -16,5 +16,5 @@ constructor(options?: ScenarioOptions); | Parameter | Type | Description | | --- | --- | --- | -| options | [ScenarioOptions](./tryorama.scenariooptions.md) | (Optional) Timeout for requests to Admin and App API calls. | +| options | [ScenarioOptions](./tryorama.scenariooptions.md) | _(Optional)_ Timeout for requests to Admin and App API calls. | diff --git a/docs/tryorama.scenario.addconductor.md b/docs/tryorama.scenario.addconductor.md index 4d01832a..dd91ebaa 100644 --- a/docs/tryorama.scenario.addconductor.md +++ b/docs/tryorama.scenario.addconductor.md @@ -6,12 +6,12 @@ Create and add a conductor to the scenario. -Signature: +**Signature:** ```typescript addConductor(): Promise; ``` -Returns: +**Returns:** Promise<[Conductor](./tryorama.conductor.md)> diff --git a/docs/tryorama.scenario.addplayerswithapps.md b/docs/tryorama.scenario.addplayerswithapps.md index 61268714..43448703 100644 --- a/docs/tryorama.scenario.addplayerswithapps.md +++ b/docs/tryorama.scenario.addplayerswithapps.md @@ -6,7 +6,7 @@ Create and add multiple players to the scenario, with an app installed for each player. -Signature: +**Signature:** ```typescript addPlayersWithApps(playersApps: Array<{ @@ -21,7 +21,7 @@ addPlayersWithApps(playersApps: Array<{ | --- | --- | --- | | playersApps | Array<{ appBundleSource: AppBundleSource; options?: [AppOptions](./tryorama.appoptions.md); }> | An array with an app for each player. | -Returns: +**Returns:** Promise<[Player](./tryorama.player.md)\[\]> diff --git a/docs/tryorama.scenario.addplayerwithapp.md b/docs/tryorama.scenario.addplayerwithapp.md index eef0d6a6..6ffddde4 100644 --- a/docs/tryorama.scenario.addplayerwithapp.md +++ b/docs/tryorama.scenario.addplayerwithapp.md @@ -6,7 +6,7 @@ Create and add a single player with an app installed to the scenario. -Signature: +**Signature:** ```typescript addPlayerWithApp(appBundleSource: AppBundleSource, options?: AppOptions): Promise; @@ -17,9 +17,9 @@ addPlayerWithApp(appBundleSource: AppBundleSource, options?: AppOptions): Promis | Parameter | Type | Description | | --- | --- | --- | | appBundleSource | AppBundleSource | The bundle or path to the bundle. | -| options | [AppOptions](./tryorama.appoptions.md) | (Optional) [AppOptions](./tryorama.appoptions.md). | +| options | [AppOptions](./tryorama.appoptions.md) | _(Optional)_ [AppOptions](./tryorama.appoptions.md). | -Returns: +**Returns:** Promise<[Player](./tryorama.player.md)> diff --git a/docs/tryorama.scenario.bootstrapserverurl.md b/docs/tryorama.scenario.bootstrapserverurl.md index 4d7bf8d5..dd98a565 100644 --- a/docs/tryorama.scenario.bootstrapserverurl.md +++ b/docs/tryorama.scenario.bootstrapserverurl.md @@ -4,7 +4,7 @@ ## Scenario.bootstrapServerUrl property -Signature: +**Signature:** ```typescript bootstrapServerUrl: URL | undefined; diff --git a/docs/tryorama.scenario.cleanup.md b/docs/tryorama.scenario.cleanup.md index 3167c68c..3a8c22e4 100644 --- a/docs/tryorama.scenario.cleanup.md +++ b/docs/tryorama.scenario.cleanup.md @@ -6,12 +6,12 @@ Shut down and delete all conductors in the scenario. -Signature: +**Signature:** ```typescript cleanUp(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.scenario.conductors.md b/docs/tryorama.scenario.conductors.md index 33281f17..77f4aa07 100644 --- a/docs/tryorama.scenario.conductors.md +++ b/docs/tryorama.scenario.conductors.md @@ -4,7 +4,7 @@ ## Scenario.conductors property -Signature: +**Signature:** ```typescript conductors: Conductor[]; diff --git a/docs/tryorama.scenario.md b/docs/tryorama.scenario.md index 86cfdaac..c77d2649 100644 --- a/docs/tryorama.scenario.md +++ b/docs/tryorama.scenario.md @@ -6,7 +6,7 @@ An abstraction of a test scenario to write tests against Holochain hApps, running on a local conductor. -Signature: +**Signature:** ```typescript export declare class Scenario diff --git a/docs/tryorama.scenario.networkseed.md b/docs/tryorama.scenario.networkseed.md index 36c7ee80..ab829389 100644 --- a/docs/tryorama.scenario.networkseed.md +++ b/docs/tryorama.scenario.networkseed.md @@ -4,7 +4,7 @@ ## Scenario.networkSeed property -Signature: +**Signature:** ```typescript networkSeed: string; diff --git a/docs/tryorama.scenario.serviceprocess.md b/docs/tryorama.scenario.serviceprocess.md index 8e63147c..851b6660 100644 --- a/docs/tryorama.scenario.serviceprocess.md +++ b/docs/tryorama.scenario.serviceprocess.md @@ -4,7 +4,7 @@ ## Scenario.serviceProcess property -Signature: +**Signature:** ```typescript serviceProcess: ChildProcessWithoutNullStreams | undefined; diff --git a/docs/tryorama.scenario.shareallagents.md b/docs/tryorama.scenario.shareallagents.md index da3e7f2b..c10494cc 100644 --- a/docs/tryorama.scenario.shareallagents.md +++ b/docs/tryorama.scenario.shareallagents.md @@ -6,12 +6,12 @@ Register all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. -Signature: +**Signature:** ```typescript shareAllAgents(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.scenario.shutdown.md b/docs/tryorama.scenario.shutdown.md index 73e5200c..75410dae 100644 --- a/docs/tryorama.scenario.shutdown.md +++ b/docs/tryorama.scenario.shutdown.md @@ -6,12 +6,12 @@ Shut down all conductors in the scenario. -Signature: +**Signature:** ```typescript shutDown(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.scenario.signalingserverurl.md b/docs/tryorama.scenario.signalingserverurl.md index 1a96815d..58d31015 100644 --- a/docs/tryorama.scenario.signalingserverurl.md +++ b/docs/tryorama.scenario.signalingserverurl.md @@ -4,7 +4,7 @@ ## Scenario.signalingServerUrl property -Signature: +**Signature:** ```typescript signalingServerUrl: URL | undefined; diff --git a/docs/tryorama.scenariooptions.md b/docs/tryorama.scenariooptions.md index 4307f419..5af22b95 100644 --- a/docs/tryorama.scenariooptions.md +++ b/docs/tryorama.scenariooptions.md @@ -6,7 +6,7 @@ Options when creating a scenario. -Signature: +**Signature:** ```typescript export interface ScenarioOptions @@ -16,5 +16,5 @@ export interface ScenarioOptions | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [timeout?](./tryorama.scenariooptions.timeout.md) | | number | (Optional) | +| [timeout?](./tryorama.scenariooptions.timeout.md) | | number | _(Optional)_ | diff --git a/docs/tryorama.scenariooptions.timeout.md b/docs/tryorama.scenariooptions.timeout.md index 4d554c2c..8fb5d486 100644 --- a/docs/tryorama.scenariooptions.timeout.md +++ b/docs/tryorama.scenariooptions.timeout.md @@ -4,7 +4,7 @@ ## ScenarioOptions.timeout property -Signature: +**Signature:** ```typescript timeout?: number; diff --git a/docs/tryorama.stoplocalservices.md b/docs/tryorama.stoplocalservices.md index 054ab3ef..984776cb 100644 --- a/docs/tryorama.stoplocalservices.md +++ b/docs/tryorama.stoplocalservices.md @@ -6,7 +6,7 @@ Shutdown signalling server process. -Signature: +**Signature:** ```typescript stopLocalServices: (localServicesProcess: ChildProcessWithoutNullStreams) => Promise | null diff --git a/docs/tryorama.trycp_server_host.md b/docs/tryorama.trycp_server_host.md index f7b14ecc..8c9b856f 100644 --- a/docs/tryorama.trycp_server_host.md +++ b/docs/tryorama.trycp_server_host.md @@ -6,7 +6,7 @@ Default TryCP server host address. -Signature: +**Signature:** ```typescript TRYCP_SERVER_HOST = "0.0.0.0" diff --git a/docs/tryorama.trycp_server_port.md b/docs/tryorama.trycp_server_port.md index a3b931b6..02530fb9 100644 --- a/docs/tryorama.trycp_server_port.md +++ b/docs/tryorama.trycp_server_port.md @@ -6,7 +6,7 @@ Default TryCP server port. -Signature: +**Signature:** ```typescript TRYCP_SERVER_PORT = 9000 diff --git a/docs/tryorama.trycp_success_response.md b/docs/tryorama.trycp_success_response.md index d8455b37..127a99b9 100644 --- a/docs/tryorama.trycp_success_response.md +++ b/docs/tryorama.trycp_success_response.md @@ -6,7 +6,7 @@ Empty success response. -Signature: +**Signature:** ```typescript TRYCP_SUCCESS_RESPONSE: null diff --git a/docs/tryorama.trycpapiresponse.md b/docs/tryorama.trycpapiresponse.md index 68941b95..63c808b2 100644 --- a/docs/tryorama.trycpapiresponse.md +++ b/docs/tryorama.trycpapiresponse.md @@ -6,10 +6,10 @@ Possible responses from the Admin and App APIs. -Signature: +**Signature:** ```typescript export type TryCpApiResponse = AdminApiResponse | AppApiResponse | ApiErrorResponse; ``` -References: [AdminApiResponse](./tryorama.adminapiresponse.md), [AppApiResponse](./tryorama.appapiresponse.md), [ApiErrorResponse](./tryorama.apierrorresponse.md) +**References:** [AdminApiResponse](./tryorama.adminapiresponse.md), [AppApiResponse](./tryorama.appapiresponse.md), [ApiErrorResponse](./tryorama.apierrorresponse.md) diff --git a/docs/tryorama.trycpclient.addconductor.md b/docs/tryorama.trycpclient.addconductor.md index 750b5b84..b40c27ff 100644 --- a/docs/tryorama.trycpclient.addconductor.md +++ b/docs/tryorama.trycpclient.addconductor.md @@ -6,7 +6,7 @@ Create and add a conductor to the client. -Signature: +**Signature:** ```typescript addConductor(partialConfig?: string): Promise; @@ -16,9 +16,9 @@ addConductor(partialConfig?: string): Promise; | Parameter | Type | Description | | --- | --- | --- | -| partialConfig | string | (Optional) Conductor configuration (optional). | +| partialConfig | string | _(Optional)_ Conductor configuration (optional). | -Returns: +**Returns:** Promise<[TryCpConductor](./tryorama.trycpconductor.md)> diff --git a/docs/tryorama.trycpclient.bootstrapserverurl.md b/docs/tryorama.trycpclient.bootstrapserverurl.md index aad71bad..738fd931 100644 --- a/docs/tryorama.trycpclient.bootstrapserverurl.md +++ b/docs/tryorama.trycpclient.bootstrapserverurl.md @@ -4,7 +4,7 @@ ## TryCpClient.bootstrapServerUrl property -Signature: +**Signature:** ```typescript bootstrapServerUrl: URL | undefined; diff --git a/docs/tryorama.trycpclient.call.md b/docs/tryorama.trycpclient.call.md index 11b0f73e..a1506827 100644 --- a/docs/tryorama.trycpclient.call.md +++ b/docs/tryorama.trycpclient.call.md @@ -6,7 +6,7 @@ Send a call to the TryCP server. -Signature: +**Signature:** ```typescript call(request: TryCpRequest): Promise; @@ -18,7 +18,7 @@ call(request: TryCpRequest): Promise; | --- | --- | --- | | request | [TryCpRequest](./tryorama.trycprequest.md) | [TryCpRequest](./tryorama.trycprequest.md) | -Returns: +**Returns:** Promise<[TryCpSuccessResponse](./tryorama.trycpsuccessresponse.md)> diff --git a/docs/tryorama.trycpclient.cleanallconductors.md b/docs/tryorama.trycpclient.cleanallconductors.md index 689d9576..a7f32b55 100644 --- a/docs/tryorama.trycpclient.cleanallconductors.md +++ b/docs/tryorama.trycpclient.cleanallconductors.md @@ -6,12 +6,12 @@ Run the `reset` command on the TryCP server to delete all conductor data. -Signature: +**Signature:** ```typescript cleanAllConductors(): Promise; ``` -Returns: +**Returns:** Promise<null> diff --git a/docs/tryorama.trycpclient.cleanup.md b/docs/tryorama.trycpclient.cleanup.md index 89d2b8ea..2064eced 100644 --- a/docs/tryorama.trycpclient.cleanup.md +++ b/docs/tryorama.trycpclient.cleanup.md @@ -6,12 +6,12 @@ Shut down all registered conductors and delete them, and close the client connection. -Signature: +**Signature:** ```typescript cleanUp(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.trycpclient.close.md b/docs/tryorama.trycpclient.close.md index 6eb689b3..8ede95cf 100644 --- a/docs/tryorama.trycpclient.close.md +++ b/docs/tryorama.trycpclient.close.md @@ -6,12 +6,12 @@ Closes the client connection. -Signature: +**Signature:** ```typescript close(): Promise; ``` -Returns: +**Returns:** Promise<unknown> diff --git a/docs/tryorama.trycpclient.conductors.md b/docs/tryorama.trycpclient.conductors.md index 0ed51e12..165744dd 100644 --- a/docs/tryorama.trycpclient.conductors.md +++ b/docs/tryorama.trycpclient.conductors.md @@ -4,7 +4,7 @@ ## TryCpClient.conductors property -Signature: +**Signature:** ```typescript conductors: TryCpConductor[]; diff --git a/docs/tryorama.trycpclient.create.md b/docs/tryorama.trycpclient.create.md index f60ecda5..1ef0eaf6 100644 --- a/docs/tryorama.trycpclient.create.md +++ b/docs/tryorama.trycpclient.create.md @@ -6,7 +6,7 @@ Create a client connection to a running TryCP server. -Signature: +**Signature:** ```typescript static create(serverUrl: URL, timeout?: number): Promise; @@ -17,9 +17,9 @@ static create(serverUrl: URL, timeout?: number): Promise; | Parameter | Type | Description | | --- | --- | --- | | serverUrl | URL | The URL of the TryCP server. | -| timeout | number | (Optional) | +| timeout | number | _(Optional)_ | -Returns: +**Returns:** Promise<[TryCpClient](./tryorama.trycpclient.md)> diff --git a/docs/tryorama.trycpclient.md b/docs/tryorama.trycpclient.md index 965cf19f..9b2ceaa7 100644 --- a/docs/tryorama.trycpclient.md +++ b/docs/tryorama.trycpclient.md @@ -8,7 +8,7 @@ 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. -Signature: +**Signature:** ```typescript export declare class TryCpClient diff --git a/docs/tryorama.trycpclient.ping.md b/docs/tryorama.trycpclient.ping.md index 1dd6a803..867c70ac 100644 --- a/docs/tryorama.trycpclient.ping.md +++ b/docs/tryorama.trycpclient.ping.md @@ -6,7 +6,7 @@ Send a ping with data. -Signature: +**Signature:** ```typescript ping(data: unknown): Promise; @@ -18,7 +18,7 @@ ping(data: unknown): Promise; | --- | --- | --- | | data | unknown | Data to send and receive with the ping-pong. | -Returns: +**Returns:** Promise<Buffer> diff --git a/docs/tryorama.trycpclient.setsignalhandler.md b/docs/tryorama.trycpclient.setsignalhandler.md index cf36fdb9..82fef969 100644 --- a/docs/tryorama.trycpclient.setsignalhandler.md +++ b/docs/tryorama.trycpclient.setsignalhandler.md @@ -4,7 +4,7 @@ ## TryCpClient.setSignalHandler() method -Signature: +**Signature:** ```typescript setSignalHandler(port: number, signalHandler?: AppSignalCb): void; @@ -15,9 +15,9 @@ setSignalHandler(port: number, signalHandler?: AppSignalCb): void; | Parameter | Type | Description | | --- | --- | --- | | port | number | | -| signalHandler | AppSignalCb | (Optional) | +| signalHandler | AppSignalCb | _(Optional)_ | -Returns: +**Returns:** void diff --git a/docs/tryorama.trycpclient.shutdownconductors.md b/docs/tryorama.trycpclient.shutdownconductors.md index c870db03..00509ecc 100644 --- a/docs/tryorama.trycpclient.shutdownconductors.md +++ b/docs/tryorama.trycpclient.shutdownconductors.md @@ -6,12 +6,12 @@ Shut down all conductors on the connected TryCP server and disconnect their app interfaces. -Signature: +**Signature:** ```typescript shutDownConductors(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.trycpclient.signalingserverurl.md b/docs/tryorama.trycpclient.signalingserverurl.md index 6136344f..4bee1a4c 100644 --- a/docs/tryorama.trycpclient.signalingserverurl.md +++ b/docs/tryorama.trycpclient.signalingserverurl.md @@ -4,7 +4,7 @@ ## TryCpClient.signalingServerUrl property -Signature: +**Signature:** ```typescript signalingServerUrl: URL | undefined; diff --git a/docs/tryorama.trycpclient.unsetsignalhandler.md b/docs/tryorama.trycpclient.unsetsignalhandler.md index 510d6522..bf8ffb02 100644 --- a/docs/tryorama.trycpclient.unsetsignalhandler.md +++ b/docs/tryorama.trycpclient.unsetsignalhandler.md @@ -4,7 +4,7 @@ ## TryCpClient.unsetSignalHandler() method -Signature: +**Signature:** ```typescript unsetSignalHandler(port: number): void; @@ -16,7 +16,7 @@ unsetSignalHandler(port: number): void; | --- | --- | --- | | port | number | | -Returns: +**Returns:** void diff --git a/docs/tryorama.trycpconductor._constructor_.md b/docs/tryorama.trycpconductor._constructor_.md index da404ed7..56fad143 100644 --- a/docs/tryorama.trycpconductor._constructor_.md +++ b/docs/tryorama.trycpconductor._constructor_.md @@ -6,7 +6,7 @@ Constructs a new instance of the `TryCpConductor` class -Signature: +**Signature:** ```typescript constructor(tryCpClient: TryCpClient, id?: ConductorId); @@ -17,5 +17,5 @@ constructor(tryCpClient: TryCpClient, id?: ConductorId); | Parameter | Type | Description | | --- | --- | --- | | tryCpClient | [TryCpClient](./tryorama.trycpclient.md) | | -| id | [ConductorId](./tryorama.conductorid.md) | (Optional) | +| id | [ConductorId](./tryorama.conductorid.md) | _(Optional)_ | diff --git a/docs/tryorama.trycpconductor.adminws.md b/docs/tryorama.trycpconductor.adminws.md index ed221d17..186eb8f6 100644 --- a/docs/tryorama.trycpconductor.adminws.md +++ b/docs/tryorama.trycpconductor.adminws.md @@ -6,7 +6,7 @@ Get all [Admin API methods](https://github.com/holochain/holochain-client-js/blob/develop/docs/API_adminwebsocket.md) of the Holochain client. -Signature: +**Signature:** ```typescript adminWs(): { @@ -38,7 +38,7 @@ adminWs(): { updateCoordinators: (request: UpdateCoordinatorsRequest) => Promise; }; ``` -Returns: +**Returns:** { addAgentInfo: (request: AddAgentInfoRequest) => Promise<void>; agentInfo: (req: AgentInfoRequest) => Promise<import("@holochain/client").AgentInfoResponse>; attachAppInterface: (request?: AttachAppInterfaceRequest) => Promise<{ port: number; }>; authorizeSigningCredentials: (cellId: CellId, functions?: GrantedFunctions) => Promise<void>; deleteCloneCell: (request: DeleteCloneCellRequest) => Promise<void>; disableApp: (request: DisableAppRequest) => Promise<null>; dumpFullState: (request: DumpFullStateRequest) => Promise<FullStateDump>; dumpNetworkStats: (request: DumpNetworkStatsRequest) => Promise<string>; dumpState: (request: DumpStateRequest) => Promise<\[FullStateDump, string\]>; enableApp: (request: EnableAppRequest) => Promise<import("@holochain/client").EnableAppResponse>; generateAgentPubKey: () => Promise<AgentPubKey>; getDnaDefinition: (dnaHash: GetDnaDefinitionRequest) => Promise<DnaDefinition>; grantSigningKey: (cellId: CellId, functions: GrantedFunctions, signingKey: AgentPubKey) => Promise<CapSecret>; grantZomeCallCapability: (request: GrantZomeCallCapabilityRequest) => Promise<void>; installApp: (data: InstallAppRequest) => Promise<AppInfo>; listAppInterfaces: () => Promise<import("@holochain/client").ListAppInterfacesResponse>; listApps: (request: ListAppsRequest) => Promise<import("@holochain/client").ListAppsResponse>; listCellIds: () => Promise<import("@holochain/client").ListCellIdsResponse>; listDnas: () => Promise<import("@holochain/client").ListDnasResponse>; registerDna: (request: RegisterDnaRequest & DnaSource) => Promise<DnaHash>; startApp: (request: StartAppRequest) => Promise<boolean>; storageInfo: (request: StorageInfoRequest) => Promise<import("@holochain/client").StorageInfo>; uninstallApp: (request: UninstallAppRequest) => Promise<null>; updateCoordinators: (request: UpdateCoordinatorsRequest) => Promise<void>; } diff --git a/docs/tryorama.trycpconductor.configure.md b/docs/tryorama.trycpconductor.configure.md index af616e31..96058753 100644 --- a/docs/tryorama.trycpconductor.configure.md +++ b/docs/tryorama.trycpconductor.configure.md @@ -6,7 +6,7 @@ Create conductor configuration. -Signature: +**Signature:** ```typescript configure(partialConfig?: string): Promise; @@ -16,9 +16,9 @@ configure(partialConfig?: string): Promise; | Parameter | Type | Description | | --- | --- | --- | -| partialConfig | string | (Optional) The configuration to add to the default configuration. | +| partialConfig | string | _(Optional)_ The configuration to add to the default configuration. | -Returns: +**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.connectappagentws.md b/docs/tryorama.trycpconductor.connectappagentws.md index 245c5d39..fcc2036c 100644 --- a/docs/tryorama.trycpconductor.connectappagentws.md +++ b/docs/tryorama.trycpconductor.connectappagentws.md @@ -4,7 +4,7 @@ ## TryCpConductor.connectAppAgentWs() method -Signature: +**Signature:** ```typescript connectAppAgentWs(port: number, appId: InstalledAppId): Promise<{ @@ -24,7 +24,7 @@ connectAppAgentWs(port: number, appId: InstalledAppId): Promise<{ | port | number | | | appId | InstalledAppId | | -Returns: +**Returns:** Promise<{ appInfo: (request: AppInfoRequest) => Promise<AppInfo>; 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 317410a4..cf160ebb 100644 --- a/docs/tryorama.trycpconductor.connectappinterface.md +++ b/docs/tryorama.trycpconductor.connectappinterface.md @@ -6,7 +6,7 @@ Connect a web socket to the App API. -Signature: +**Signature:** ```typescript connectAppInterface(port: number): Promise; @@ -18,7 +18,7 @@ connectAppInterface(port: number): Promise; | --- | --- | --- | | port | number | The port to attach the app interface to. | -Returns: +**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.connectappws.md b/docs/tryorama.trycpconductor.connectappws.md index 76aadcf2..c20988ac 100644 --- a/docs/tryorama.trycpconductor.connectappws.md +++ b/docs/tryorama.trycpconductor.connectappws.md @@ -6,7 +6,7 @@ Get all [App API methods](https://github.com/holochain/holochain-client-js/blob/develop/docs/API_appwebsocket.md) of the Holochain client. -Signature: +**Signature:** ```typescript connectAppWs(port: number): Promise<{ @@ -25,7 +25,7 @@ connectAppWs(port: number): Promise<{ | --- | --- | --- | | port | number | | -Returns: +**Returns:** Promise<{ appInfo: (request: AppInfoRequest) => Promise<AppInfo>; 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 e795d3ee..4097ae33 100644 --- a/docs/tryorama.trycpconductor.disconnectappinterface.md +++ b/docs/tryorama.trycpconductor.disconnectappinterface.md @@ -6,7 +6,7 @@ Disconnect a web socket from the App API. -Signature: +**Signature:** ```typescript disconnectAppInterface(port: number): Promise; @@ -18,7 +18,7 @@ disconnectAppInterface(port: number): Promise; | --- | --- | --- | | port | number | The port of the app interface to disconnect. | -Returns: +**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.disconnectclient.md b/docs/tryorama.trycpconductor.disconnectclient.md index 27fcbe91..ef5b700b 100644 --- a/docs/tryorama.trycpconductor.disconnectclient.md +++ b/docs/tryorama.trycpconductor.disconnectclient.md @@ -6,12 +6,12 @@ Disconnect the TryCP client from the TryCP server. -Signature: +**Signature:** ```typescript disconnectClient(): Promise; ``` -Returns: +**Returns:** Promise<number> diff --git a/docs/tryorama.trycpconductor.downloaddna.md b/docs/tryorama.trycpconductor.downloaddna.md index a68b9fc0..489b7494 100644 --- a/docs/tryorama.trycpconductor.downloaddna.md +++ b/docs/tryorama.trycpconductor.downloaddna.md @@ -6,7 +6,7 @@ Download a DNA from a URL to the server's file system. -Signature: +**Signature:** ```typescript downloadDna(url: URL): Promise; @@ -18,7 +18,7 @@ downloadDna(url: URL): Promise; | --- | --- | --- | | url | URL | | -Returns: +**Returns:** Promise<string> diff --git a/docs/tryorama.trycpconductor.id.md b/docs/tryorama.trycpconductor.id.md index d69f27b5..8af298b6 100644 --- a/docs/tryorama.trycpconductor.id.md +++ b/docs/tryorama.trycpconductor.id.md @@ -4,7 +4,7 @@ ## TryCpConductor.id property -Signature: +**Signature:** ```typescript readonly id: string; diff --git a/docs/tryorama.trycpconductor.installagentsapps.md b/docs/tryorama.trycpconductor.installagentsapps.md index 4bf26c88..884bfdae 100644 --- a/docs/tryorama.trycpconductor.installagentsapps.md +++ b/docs/tryorama.trycpconductor.installagentsapps.md @@ -6,7 +6,7 @@ Install a hApp bundle into the conductor. -Signature: +**Signature:** ```typescript installAgentsApps(options: AgentsAppsOptions): Promise; @@ -18,7 +18,7 @@ installAgentsApps(options: AgentsAppsOptions): Promise; | --- | --- | --- | | options | [AgentsAppsOptions](./tryorama.agentsappsoptions.md) | Apps to install for each agent, with agent pub keys etc. | -Returns: +**Returns:** Promise<AppInfo\[\]> diff --git a/docs/tryorama.trycpconductor.installapp.md b/docs/tryorama.trycpconductor.installapp.md index ba29f1f2..d53bc61d 100644 --- a/docs/tryorama.trycpconductor.installapp.md +++ b/docs/tryorama.trycpconductor.installapp.md @@ -6,7 +6,7 @@ Install a hApp bundle into the conductor. -Signature: +**Signature:** ```typescript installApp(appBundleSource: AppBundleSource, options?: AppOptions): Promise; @@ -17,9 +17,9 @@ installApp(appBundleSource: AppBundleSource, options?: AppOptions): Promise(Optional) [AppOptions](./tryorama.appoptions.md) for the hApp bundle (optional). | +| options | [AppOptions](./tryorama.appoptions.md) | _(Optional)_ [AppOptions](./tryorama.appoptions.md) for the hApp bundle (optional). | -Returns: +**Returns:** Promise<AppInfo> diff --git a/docs/tryorama.trycpconductor.md b/docs/tryorama.trycpconductor.md index 2a403a89..12541d56 100644 --- a/docs/tryorama.trycpconductor.md +++ b/docs/tryorama.trycpconductor.md @@ -6,12 +6,12 @@ A class to manage a conductor running on a TryCP server. -Signature: +**Signature:** ```typescript export declare class TryCpConductor implements IConductor ``` -Implements: [IConductor](./tryorama.iconductor.md) +**Implements:** [IConductor](./tryorama.iconductor.md) ## Constructors diff --git a/docs/tryorama.trycpconductor.off.md b/docs/tryorama.trycpconductor.off.md index 83c1d043..0ab5291d 100644 --- a/docs/tryorama.trycpconductor.off.md +++ b/docs/tryorama.trycpconductor.off.md @@ -6,7 +6,7 @@ Detach the registered signal handler. -Signature: +**Signature:** ```typescript off(port: number): void; @@ -18,7 +18,7 @@ off(port: number): void; | --- | --- | --- | | port | number | | -Returns: +**Returns:** void diff --git a/docs/tryorama.trycpconductor.on.md b/docs/tryorama.trycpconductor.on.md index 1cabbd64..92cff933 100644 --- a/docs/tryorama.trycpconductor.on.md +++ b/docs/tryorama.trycpconductor.on.md @@ -6,7 +6,7 @@ Attach a signal handler. -Signature: +**Signature:** ```typescript on(port: number, signalHandler: AppSignalCb): void; @@ -19,7 +19,7 @@ on(port: number, signalHandler: AppSignalCb): void; | port | number | The port of the app interface. | | signalHandler | AppSignalCb | The signal handler to register. | -Returns: +**Returns:** void diff --git a/docs/tryorama.trycpconductor.savedna.md b/docs/tryorama.trycpconductor.savedna.md index 8230c3c0..98282488 100644 --- a/docs/tryorama.trycpconductor.savedna.md +++ b/docs/tryorama.trycpconductor.savedna.md @@ -6,7 +6,7 @@ Upload a DNA file from the local file system to the server. -Signature: +**Signature:** ```typescript saveDna(dnaContent: Buffer): Promise; @@ -18,7 +18,7 @@ saveDna(dnaContent: Buffer): Promise; | --- | --- | --- | | dnaContent | Buffer | The DNA as binary content. | -Returns: +**Returns:** Promise<string> diff --git a/docs/tryorama.trycpconductor.shutdown.md b/docs/tryorama.trycpconductor.shutdown.md index bf8f29a3..c2ce17d4 100644 --- a/docs/tryorama.trycpconductor.shutdown.md +++ b/docs/tryorama.trycpconductor.shutdown.md @@ -6,12 +6,12 @@ Shut down the conductor. -Signature: +**Signature:** ```typescript shutDown(): Promise; ``` -Returns: +**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.startup.md b/docs/tryorama.trycpconductor.startup.md index 7593aa74..28c20c53 100644 --- a/docs/tryorama.trycpconductor.startup.md +++ b/docs/tryorama.trycpconductor.startup.md @@ -6,7 +6,7 @@ Start a configured conductor. -Signature: +**Signature:** ```typescript startUp(options?: { @@ -18,9 +18,9 @@ startUp(options?: { | Parameter | Type | Description | | --- | --- | --- | -| options | { logLevel?: [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md); } | (Optional) Log level of the conductor. Defaults to "info". | +| options | { logLevel?: [TryCpConductorLogLevel](./tryorama.trycpconductorloglevel.md); } | _(Optional)_ Log level of the conductor. Defaults to "info". | -Returns: +**Returns:** Promise<null> diff --git a/docs/tryorama.trycpconductor.trycpclient.md b/docs/tryorama.trycpconductor.trycpclient.md index 1ca8581c..7958bbf6 100644 --- a/docs/tryorama.trycpconductor.trycpclient.md +++ b/docs/tryorama.trycpconductor.trycpclient.md @@ -4,7 +4,7 @@ ## TryCpConductor.tryCpClient property -Signature: +**Signature:** ```typescript readonly tryCpClient: TryCpClient; diff --git a/docs/tryorama.trycpconductorloglevel.md b/docs/tryorama.trycpconductorloglevel.md index 74c79a6e..be1a05d5 100644 --- a/docs/tryorama.trycpconductorloglevel.md +++ b/docs/tryorama.trycpconductorloglevel.md @@ -6,7 +6,7 @@ Log level for a TryCP conductor. -Signature: +**Signature:** ```typescript export type TryCpConductorLogLevel = "error" | "warn" | "info" | "debug" | "trace"; diff --git a/docs/tryorama.trycpconductoroptions.id.md b/docs/tryorama.trycpconductoroptions.id.md index 5722b17c..1f872812 100644 --- a/docs/tryorama.trycpconductoroptions.id.md +++ b/docs/tryorama.trycpconductoroptions.id.md @@ -6,7 +6,7 @@ Identifier for the conductor (optional). -Signature: +**Signature:** ```typescript id?: ConductorId; diff --git a/docs/tryorama.trycpconductoroptions.loglevel.md b/docs/tryorama.trycpconductoroptions.loglevel.md index c620da52..ca8e8f7e 100644 --- a/docs/tryorama.trycpconductoroptions.loglevel.md +++ b/docs/tryorama.trycpconductoroptions.loglevel.md @@ -8,7 +8,7 @@ Log level of the conductor (optional). default: "info" -Signature: +**Signature:** ```typescript logLevel?: TryCpConductorLogLevel; diff --git a/docs/tryorama.trycpconductoroptions.md b/docs/tryorama.trycpconductoroptions.md index 16701fc2..42ccaaf5 100644 --- a/docs/tryorama.trycpconductoroptions.md +++ b/docs/tryorama.trycpconductoroptions.md @@ -5,7 +5,7 @@ ## TryCpConductorOptions interface -Signature: +**Signature:** ```typescript export interface TryCpConductorOptions @@ -15,8 +15,8 @@ export interface TryCpConductorOptions | 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

| +| [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.trycpconductoroptions.partialconfig.md b/docs/tryorama.trycpconductoroptions.partialconfig.md index fe3ecbfc..47358c3d 100644 --- a/docs/tryorama.trycpconductoroptions.partialconfig.md +++ b/docs/tryorama.trycpconductoroptions.partialconfig.md @@ -6,7 +6,7 @@ Configuration for the conductor (optional). -Signature: +**Signature:** ```typescript partialConfig?: string; diff --git a/docs/tryorama.trycpconductoroptions.startup.md b/docs/tryorama.trycpconductoroptions.startup.md index 219a348c..55f526d5 100644 --- a/docs/tryorama.trycpconductoroptions.startup.md +++ b/docs/tryorama.trycpconductoroptions.startup.md @@ -8,7 +8,7 @@ Start up conductor after creation. default: true -Signature: +**Signature:** ```typescript startup?: boolean; diff --git a/docs/tryorama.trycpplayer.conductor.md b/docs/tryorama.trycpplayer.conductor.md index 3cc16d26..1c3ef763 100644 --- a/docs/tryorama.trycpplayer.conductor.md +++ b/docs/tryorama.trycpplayer.conductor.md @@ -4,7 +4,7 @@ ## TryCpPlayer.conductor property -Signature: +**Signature:** ```typescript conductor: TryCpConductor; diff --git a/docs/tryorama.trycpplayer.md b/docs/tryorama.trycpplayer.md index 4768c0cd..73d03232 100644 --- a/docs/tryorama.trycpplayer.md +++ b/docs/tryorama.trycpplayer.md @@ -6,12 +6,12 @@ A player tied to a [TryCpConductor](./tryorama.trycpconductor.md). -Signature: +**Signature:** ```typescript export interface TryCpPlayer extends IPlayer ``` -Extends: [IPlayer](./tryorama.iplayer.md) +**Extends:** [IPlayer](./tryorama.iplayer.md) ## Properties diff --git a/docs/tryorama.trycprequest.md b/docs/tryorama.trycprequest.md index 2df334c7..622284ac 100644 --- a/docs/tryorama.trycprequest.md +++ b/docs/tryorama.trycprequest.md @@ -6,10 +6,10 @@ Contains all possible request types. -Signature: +**Signature:** ```typescript export type TryCpRequest = RequestDownloadDna | RequestSaveDna | RequestConfigurePlayer | RequestStartup | RequestShutdown | RequestReset | RequestConnectAppInterface | RequestDisconnectAppInterface | RequestCallAppInterface | RequestCallAppInterfaceEncoded | RequestCallAdminInterface; ``` -References: [RequestDownloadDna](./tryorama.requestdownloaddna.md), [RequestSaveDna](./tryorama.requestsavedna.md), [RequestConfigurePlayer](./tryorama.requestconfigureplayer.md), [RequestStartup](./tryorama.requeststartup.md), [RequestShutdown](./tryorama.requestshutdown.md), [RequestReset](./tryorama.requestreset.md), [RequestConnectAppInterface](./tryorama.requestconnectappinterface.md), [RequestDisconnectAppInterface](./tryorama.requestdisconnectappinterface.md), [RequestCallAppInterface](./tryorama.requestcallappinterface.md), [RequestCallAppInterfaceEncoded](./tryorama.requestcallappinterfaceencoded.md), [RequestCallAdminInterface](./tryorama.requestcalladmininterface.md) +**References:** [RequestDownloadDna](./tryorama.requestdownloaddna.md), [RequestSaveDna](./tryorama.requestsavedna.md), [RequestConfigurePlayer](./tryorama.requestconfigureplayer.md), [RequestStartup](./tryorama.requeststartup.md), [RequestShutdown](./tryorama.requestshutdown.md), [RequestReset](./tryorama.requestreset.md), [RequestConnectAppInterface](./tryorama.requestconnectappinterface.md), [RequestDisconnectAppInterface](./tryorama.requestdisconnectappinterface.md), [RequestCallAppInterface](./tryorama.requestcallappinterface.md), [RequestCallAppInterfaceEncoded](./tryorama.requestcallappinterfaceencoded.md), [RequestCallAdminInterface](./tryorama.requestcalladmininterface.md) diff --git a/docs/tryorama.trycpresponseerrorvalue.md b/docs/tryorama.trycpresponseerrorvalue.md index 6a7e07e6..a3f6aa32 100644 --- a/docs/tryorama.trycpresponseerrorvalue.md +++ b/docs/tryorama.trycpresponseerrorvalue.md @@ -6,7 +6,7 @@ Error response values. -Signature: +**Signature:** ```typescript export type TryCpResponseErrorValue = string | Error; diff --git a/docs/tryorama.trycpscenario._constructor_.md b/docs/tryorama.trycpscenario._constructor_.md index 8179f109..7c7a7db3 100644 --- a/docs/tryorama.trycpscenario._constructor_.md +++ b/docs/tryorama.trycpscenario._constructor_.md @@ -6,7 +6,7 @@ Constructs a new instance of the `TryCpScenario` class -Signature: +**Signature:** ```typescript constructor(); diff --git a/docs/tryorama.trycpscenario.addclient.md b/docs/tryorama.trycpscenario.addclient.md index 734ee896..adc15af5 100644 --- a/docs/tryorama.trycpscenario.addclient.md +++ b/docs/tryorama.trycpscenario.addclient.md @@ -6,7 +6,7 @@ Creates a TryCP client connection and add it to the scenario. -Signature: +**Signature:** ```typescript addClient(serverUrl: URL, timeout?: number): Promise; @@ -17,9 +17,9 @@ addClient(serverUrl: URL, timeout?: number): Promise; | Parameter | Type | Description | | --- | --- | --- | | serverUrl | URL | The TryCP server URL to connect to. | -| timeout | number | (Optional) An optional timeout for the web socket connection. | +| timeout | number | _(Optional)_ An optional timeout for the web socket connection. | -Returns: +**Returns:** Promise<[TryCpClient](./tryorama.trycpclient.md)> diff --git a/docs/tryorama.trycpscenario.addclientsplayers.md b/docs/tryorama.trycpscenario.addclientsplayers.md index 92aad86a..bbd2130b 100644 --- a/docs/tryorama.trycpscenario.addclientsplayers.md +++ b/docs/tryorama.trycpscenario.addclientsplayers.md @@ -8,7 +8,7 @@ Creates client connections for all passed in URLs and, depending on the options, If no number of agents per conductor is specified, it defaults to 1. -Signature: +**Signature:** ```typescript addClientsPlayers(serverUrls: URL[], options: ClientsPlayersOptions): Promise; @@ -21,7 +21,7 @@ addClientsPlayers(serverUrls: URL[], options: ClientsPlayersOptions): PromiseReturns: +**Returns:** Promise<[ClientPlayers](./tryorama.clientplayers.md)\[\]> diff --git a/docs/tryorama.trycpscenario.addplayerswithapps.md b/docs/tryorama.trycpscenario.addplayerswithapps.md index 5b47cbab..6c39324e 100644 --- a/docs/tryorama.trycpscenario.addplayerswithapps.md +++ b/docs/tryorama.trycpscenario.addplayerswithapps.md @@ -6,7 +6,7 @@ Creates and adds multiple players with an installed app to the scenario. -Signature: +**Signature:** ```typescript addPlayersWithApps(tryCpClient: TryCpClient, playersApps: Array<{ @@ -22,7 +22,7 @@ addPlayersWithApps(tryCpClient: TryCpClient, playersApps: Array<{ | 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: +**Returns:** Promise<[TryCpPlayer](./tryorama.trycpplayer.md)\[\]> diff --git a/docs/tryorama.trycpscenario.addplayerwithapp.md b/docs/tryorama.trycpscenario.addplayerwithapp.md index bb243296..f1cdb3bd 100644 --- a/docs/tryorama.trycpscenario.addplayerwithapp.md +++ b/docs/tryorama.trycpscenario.addplayerwithapp.md @@ -6,7 +6,7 @@ Creates and adds a single player with an installed app to the scenario, -Signature: +**Signature:** ```typescript addPlayerWithApp(tryCpClient: TryCpClient, appBundleSource: AppBundleSource, options?: AppOptions): Promise; @@ -18,9 +18,9 @@ addPlayerWithApp(tryCpClient: TryCpClient, appBundleSource: AppBundleSource, opt | --- | --- | --- | | 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. | +| options | [AppOptions](./tryorama.appoptions.md) | _(Optional)_ [AppOptions](./tryorama.appoptions.md) like agent pub key etc. | -Returns: +**Returns:** Promise<[TryCpPlayer](./tryorama.trycpplayer.md)> diff --git a/docs/tryorama.trycpscenario.bootstrapserverurl.md b/docs/tryorama.trycpscenario.bootstrapserverurl.md index 723f933f..2c2f090e 100644 --- a/docs/tryorama.trycpscenario.bootstrapserverurl.md +++ b/docs/tryorama.trycpscenario.bootstrapserverurl.md @@ -4,7 +4,7 @@ ## TryCpScenario.bootstrapServerUrl property -Signature: +**Signature:** ```typescript bootstrapServerUrl: URL | undefined; diff --git a/docs/tryorama.trycpscenario.cleanup.md b/docs/tryorama.trycpscenario.cleanup.md index 479f6ac8..7056c3fa 100644 --- a/docs/tryorama.trycpscenario.cleanup.md +++ b/docs/tryorama.trycpscenario.cleanup.md @@ -6,12 +6,12 @@ Shut down and delete all conductors and close all client connections in the scenario. -Signature: +**Signature:** ```typescript cleanUp(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.trycpscenario.clients.md b/docs/tryorama.trycpscenario.clients.md index 67716b96..89003666 100644 --- a/docs/tryorama.trycpscenario.clients.md +++ b/docs/tryorama.trycpscenario.clients.md @@ -4,7 +4,7 @@ ## TryCpScenario.clients property -Signature: +**Signature:** ```typescript clients: TryCpClient[]; diff --git a/docs/tryorama.trycpscenario.md b/docs/tryorama.trycpscenario.md index 529ad870..6250b6d0 100644 --- a/docs/tryorama.trycpscenario.md +++ b/docs/tryorama.trycpscenario.md @@ -8,7 +8,7 @@ A test scenario abstraction with convenience functions to manage TryCP clients a 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. -Signature: +**Signature:** ```typescript export declare class TryCpScenario diff --git a/docs/tryorama.trycpscenario.network_seed.md b/docs/tryorama.trycpscenario.network_seed.md index fd1318c4..c0b0777b 100644 --- a/docs/tryorama.trycpscenario.network_seed.md +++ b/docs/tryorama.trycpscenario.network_seed.md @@ -4,7 +4,7 @@ ## TryCpScenario.network\_seed property -Signature: +**Signature:** ```typescript network_seed: string; diff --git a/docs/tryorama.trycpscenario.servicesprocess.md b/docs/tryorama.trycpscenario.servicesprocess.md index fc6758c6..5e737963 100644 --- a/docs/tryorama.trycpscenario.servicesprocess.md +++ b/docs/tryorama.trycpscenario.servicesprocess.md @@ -4,7 +4,7 @@ ## TryCpScenario.servicesProcess property -Signature: +**Signature:** ```typescript servicesProcess: ChildProcessWithoutNullStreams | undefined; diff --git a/docs/tryorama.trycpscenario.shareallagents.md b/docs/tryorama.trycpscenario.shareallagents.md index 7b868838..ff80d84f 100644 --- a/docs/tryorama.trycpscenario.shareallagents.md +++ b/docs/tryorama.trycpscenario.shareallagents.md @@ -6,12 +6,12 @@ Registers all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. -Signature: +**Signature:** ```typescript shareAllAgents(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.trycpscenario.shutdown.md b/docs/tryorama.trycpscenario.shutdown.md index ab34d480..d2deeecb 100644 --- a/docs/tryorama.trycpscenario.shutdown.md +++ b/docs/tryorama.trycpscenario.shutdown.md @@ -6,12 +6,12 @@ Shut down all conductors of all clients in the scenario. -Signature: +**Signature:** ```typescript shutDown(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.trycpscenario.signalingserverurl.md b/docs/tryorama.trycpscenario.signalingserverurl.md index d127041b..1e082b18 100644 --- a/docs/tryorama.trycpscenario.signalingserverurl.md +++ b/docs/tryorama.trycpscenario.signalingserverurl.md @@ -4,7 +4,7 @@ ## TryCpScenario.signalingServerUrl property -Signature: +**Signature:** ```typescript signalingServerUrl: URL | undefined; diff --git a/docs/tryorama.trycpserver.md b/docs/tryorama.trycpserver.md index 4c97306b..24650fc2 100644 --- a/docs/tryorama.trycpserver.md +++ b/docs/tryorama.trycpserver.md @@ -6,7 +6,7 @@ A factory class to start and stop local instances of the TryCP server. -Signature: +**Signature:** ```typescript export declare class TryCpServer diff --git a/docs/tryorama.trycpserver.start.md b/docs/tryorama.trycpserver.start.md index 07a3e36e..855cdbf8 100644 --- a/docs/tryorama.trycpserver.start.md +++ b/docs/tryorama.trycpserver.start.md @@ -6,7 +6,7 @@ Builds and starts a local TryCP server on the specified port. -Signature: +**Signature:** ```typescript static start(port?: number): Promise; @@ -16,9 +16,9 @@ static start(port?: number): Promise; | Parameter | Type | Description | | --- | --- | --- | -| port | number | (Optional) The network port the server should listen on. | +| port | number | _(Optional)_ The network port the server should listen on. | -Returns: +**Returns:** Promise<[TryCpServer](./tryorama.trycpserver.md)> diff --git a/docs/tryorama.trycpserver.stop.md b/docs/tryorama.trycpserver.stop.md index fc331c18..0456185a 100644 --- a/docs/tryorama.trycpserver.stop.md +++ b/docs/tryorama.trycpserver.stop.md @@ -6,12 +6,12 @@ Stops the server instance by killing the server process. -Signature: +**Signature:** ```typescript stop(): Promise; ``` -Returns: +**Returns:** Promise<void> diff --git a/docs/tryorama.trycpsuccessresponse.md b/docs/tryorama.trycpsuccessresponse.md index 3e8ae439..4e653415 100644 --- a/docs/tryorama.trycpsuccessresponse.md +++ b/docs/tryorama.trycpsuccessresponse.md @@ -6,10 +6,10 @@ Possible values a for success response from the TryCP server. -Signature: +**Signature:** ```typescript export type TryCpSuccessResponse = typeof TRYCP_SUCCESS_RESPONSE | string | TryCpApiResponse; ``` -References: [TRYCP\_SUCCESS\_RESPONSE](./tryorama.trycp_success_response.md), [TryCpApiResponse](./tryorama.trycpapiresponse.md) +**References:** [TRYCP\_SUCCESS\_RESPONSE](./tryorama.trycp_success_response.md), [TryCpApiResponse](./tryorama.trycpapiresponse.md) diff --git a/package-lock.json b/package-lock.json index 22c6783a..ed74666a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@holochain/tryorama", - "version": "0.15.0", + "version": "0.15.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@holochain/tryorama", - "version": "0.15.0", + "version": "0.15.1", "license": "CAL-1.0", "dependencies": { "@holochain/client": "^0.16.0", @@ -643,15 +643,15 @@ } }, "node_modules/@microsoft/api-documenter": { - "version": "7.19.27", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.19.27.tgz", - "integrity": "sha512-KKNUnDlhRx+tYZsDt3Bn8OqdpCS8V9pce+ZvCjkL+nGHN4G2w1lqAtm82VdzGYgG8HgrwqZ72/Z2bsxKvPho7g==", + "version": "7.23.9", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.23.9.tgz", + "integrity": "sha512-CvOy3JF0oCDm3GDqce3uFS9QGO72lfOEgVbvpje32O+ug/WoL8ITOg2jZszMtowuClasPbpEcEoVsHJJLePirg==", "dev": true, "dependencies": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.28.2", "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "3.53.3", - "@rushstack/ts-command-line": "4.13.1", + "@rushstack/node-core-library": "3.61.0", + "@rushstack/ts-command-line": "4.16.1", "colors": "~1.2.1", "js-yaml": "~3.13.1", "resolve": "~1.22.1" @@ -660,68 +660,51 @@ "api-documenter": "bin/api-documenter" } }, - "node_modules/@microsoft/api-documenter/node_modules/resolve": { - "version": "1.22.1", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", - "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==", - "dev": true, - "dependencies": { - "is-core-module": "^2.9.0", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" - }, - "bin": { - "resolve": "bin/resolve" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/@microsoft/api-extractor": { - "version": "7.33.7", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.33.7.tgz", - "integrity": "sha512-fQT2v/j/55DhvMFiopLtth66E7xTFNhnumMKgKY14SaG6qU/V1W0e4nOAgbA+SmLakQjAd1Evu06ofaVaxBPbA==", + "version": "7.38.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.38.0.tgz", + "integrity": "sha512-e1LhZYnfw+JEebuY2bzhw0imDCl1nwjSThTrQqBXl40hrVo6xm3j/1EpUr89QyzgjqmAwek2ZkIVZbrhaR+cqg==", "dev": true, "dependencies": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.28.2", "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3", - "@rushstack/rig-package": "0.3.17", - "@rushstack/ts-command-line": "4.13.1", + "@rushstack/node-core-library": "3.61.0", + "@rushstack/rig-package": "0.5.1", + "@rushstack/ts-command-line": "4.16.1", "colors": "~1.2.1", "lodash": "~4.17.15", - "resolve": "~1.17.0", - "semver": "~7.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "source-map": "~0.6.1", - "typescript": "~4.8.4" + "typescript": "~5.0.4" }, "bin": { "api-extractor": "bin/api-extractor" } }, "node_modules/@microsoft/api-extractor-model": { - "version": "7.25.3", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.25.3.tgz", - "integrity": "sha512-WWxBUq77p2iZ+5VF7Nmrm3y/UtqCh5bYV8ii3khwq3w99+fXWpvfsAhgSLsC7k8XDQc6De4ssMxH6He/qe1pzg==", + "version": "7.28.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.2.tgz", + "integrity": "sha512-vkojrM2fo3q4n4oPh4uUZdjJ2DxQ2+RnDQL/xhTWSRUNPF6P4QyrvY357HBxbnltKcYu+nNNolVqc6TIGQ73Ig==", "dev": true, "dependencies": { "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3" + "@rushstack/node-core-library": "3.61.0" } }, "node_modules/@microsoft/api-extractor/node_modules/typescript": { - "version": "4.8.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz", - "integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==", + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", + "integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==", "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=4.2.0" + "node": ">=12.20" } }, "node_modules/@microsoft/tsdoc": { @@ -810,41 +793,42 @@ } }, "node_modules/@rushstack/node-core-library": { - "version": "3.53.3", - "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.53.3.tgz", - "integrity": "sha512-H0+T5koi5MFhJUd5ND3dI3bwLhvlABetARl78L3lWftJVQEPyzcgTStvTTRiIM5mCltyTM8VYm6BuCtNUuxD0Q==", + "version": "3.61.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.61.0.tgz", + "integrity": "sha512-tdOjdErme+/YOu4gPed3sFS72GhtWCgNV9oDsHDnoLY5oDfwjKUc9Z+JOZZ37uAxcm/OCahDHfuu2ugqrfWAVQ==", "dev": true, "dependencies": { - "@types/node": "12.20.24", "colors": "~1.2.1", "fs-extra": "~7.0.1", "import-lazy": "~4.0.0", "jju": "~1.4.0", - "resolve": "~1.17.0", - "semver": "~7.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "z-schema": "~5.0.2" + }, + "peerDependencies": { + "@types/node": "*" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } } }, - "node_modules/@rushstack/node-core-library/node_modules/@types/node": { - "version": "12.20.24", - "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", - "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", - "dev": true - }, "node_modules/@rushstack/rig-package": { - "version": "0.3.17", - "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.17.tgz", - "integrity": "sha512-nxvAGeIMnHl1LlZSQmacgcRV4y1EYtgcDIrw6KkeVjudOMonlxO482PhDj3LVZEp6L7emSf6YSO2s5JkHlwfZA==", + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.5.1.tgz", + "integrity": "sha512-pXRYSe29TjRw7rqxD4WS3HN/sRSbfr+tJs4a9uuaSIBAITbUggygdhuG0VrO0EO+QqH91GhYMN4S6KRtOEmGVA==", "dev": true, "dependencies": { - "resolve": "~1.17.0", + "resolve": "~1.22.1", "strip-json-comments": "~3.1.1" } }, "node_modules/@rushstack/ts-command-line": { - "version": "4.13.1", - "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.13.1.tgz", - "integrity": "sha512-UTQMRyy/jH1IS2U+6pyzyn9xQ2iMcoUKkTcZUzOP/aaMiKlWLwCTDiBVwhw/M1crDx6apF9CwyjuWO9r1SBdJQ==", + "version": "4.16.1", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.16.1.tgz", + "integrity": "sha512-+OCsD553GYVLEmz12yiFjMOzuPeCiZ3f8wTiFHL30ZVXexTyPmgjwXEhg2K2P0a2lVf+8YBy7WtPoflB2Fp8/A==", "dev": true, "dependencies": { "@types/argparse": "1.0.38", @@ -1615,11 +1599,14 @@ } }, "node_modules/commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "version": "9.5.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", + "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", "dev": true, - "optional": true + "optional": true, + "engines": { + "node": "^12.20.0 || >=14" + } }, "node_modules/concat-map": { "version": "0.0.1", @@ -2428,9 +2415,9 @@ } }, "node_modules/get-func-name": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", - "integrity": "sha512-Hm0ixYtaSZ/V7C8FJrtZIuBBI+iSgL+1Aq82zSu8VQNB4S3Gk8e7Qs3VwBDJAhmRZcFqkl3tQu36g/Foh5I5ig==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.2.tgz", + "integrity": "sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==", "dev": true, "engines": { "node": "*" @@ -2566,9 +2553,9 @@ } }, "node_modules/graceful-fs": { - "version": "4.2.10", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", - "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", "dev": true }, "node_modules/graphemer": { @@ -2793,9 +2780,9 @@ } }, "node_modules/is-core-module": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.11.0.tgz", - "integrity": "sha512-RRjxlvLDkD1YJwDbroBHMb+cukurkDWNyHx7D3oNB5x9rb5ogcksMC5wHCadcXoo67gVr/+3GFySh3134zi6rw==", + "version": "2.13.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.0.tgz", + "integrity": "sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ==", "dev": true, "dependencies": { "has": "^1.0.3" @@ -3608,9 +3595,9 @@ } }, "node_modules/postcss": { - "version": "8.4.25", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.25.tgz", - "integrity": "sha512-7taJ/8t2av0Z+sQEvNzCkpDynl0tX3uJMCODi6nT3PfASC7dYCWV9aQ+uiCf+KBD4SEFcu+GvJdGdwzQ6OSjCw==", + "version": "8.4.31", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.31.tgz", + "integrity": "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==", "dev": true, "funding": [ { @@ -3775,12 +3762,17 @@ } }, "node_modules/resolve": { - "version": "1.17.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "version": "1.22.6", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.6.tgz", + "integrity": "sha512-njhxM7mV12JfufShqGy3Rz8j11RPdLy4xi15UurGJeoHLfJpVXKdh3ueuOqbYUcDZnffr6X739JBo5LzyahEsw==", "dev": true, "dependencies": { - "path-parse": "^1.0.6" + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -3910,9 +3902,9 @@ } }, "node_modules/semver": { - "version": "7.3.8", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", - "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", "dev": true, "dependencies": { "lru-cache": "^6.0.0" @@ -4071,9 +4063,9 @@ } }, "node_modules/string-argv": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", - "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz", + "integrity": "sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==", "dev": true, "engines": { "node": ">=0.6.19" @@ -4488,9 +4480,9 @@ "dev": true }, "node_modules/validator": { - "version": "13.7.0", - "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", - "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz", + "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==", "dev": true, "engines": { "node": ">= 0.10" @@ -4821,9 +4813,9 @@ } }, "node_modules/z-schema": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.4.tgz", - "integrity": "sha512-gm/lx3hDzJNcLwseIeQVm1UcwhWIKpSB4NqH89pTBtFns4k/HDHudsICtvG05Bvw/Mv3jMyk700y5dadueLHdA==", + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", + "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", "dev": true, "dependencies": { "lodash.get": "^4.4.2", @@ -4837,7 +4829,7 @@ "node": ">=8.0.0" }, "optionalDependencies": { - "commander": "^2.20.3" + "commander": "^9.4.1" } } }, @@ -5158,70 +5150,57 @@ } }, "@microsoft/api-documenter": { - "version": "7.19.27", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.19.27.tgz", - "integrity": "sha512-KKNUnDlhRx+tYZsDt3Bn8OqdpCS8V9pce+ZvCjkL+nGHN4G2w1lqAtm82VdzGYgG8HgrwqZ72/Z2bsxKvPho7g==", + "version": "7.23.9", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.23.9.tgz", + "integrity": "sha512-CvOy3JF0oCDm3GDqce3uFS9QGO72lfOEgVbvpje32O+ug/WoL8ITOg2jZszMtowuClasPbpEcEoVsHJJLePirg==", "dev": true, "requires": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.28.2", "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "3.53.3", - "@rushstack/ts-command-line": "4.13.1", + "@rushstack/node-core-library": "3.61.0", + "@rushstack/ts-command-line": "4.16.1", "colors": "~1.2.1", "js-yaml": "~3.13.1", "resolve": "~1.22.1" - }, - "dependencies": { - "resolve": { - "version": "1.22.1", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz", - "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==", - "dev": true, - "requires": { - "is-core-module": "^2.9.0", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" - } - } } }, "@microsoft/api-extractor": { - "version": "7.33.7", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.33.7.tgz", - "integrity": "sha512-fQT2v/j/55DhvMFiopLtth66E7xTFNhnumMKgKY14SaG6qU/V1W0e4nOAgbA+SmLakQjAd1Evu06ofaVaxBPbA==", + "version": "7.38.0", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.38.0.tgz", + "integrity": "sha512-e1LhZYnfw+JEebuY2bzhw0imDCl1nwjSThTrQqBXl40hrVo6xm3j/1EpUr89QyzgjqmAwek2ZkIVZbrhaR+cqg==", "dev": true, "requires": { - "@microsoft/api-extractor-model": "7.25.3", + "@microsoft/api-extractor-model": "7.28.2", "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3", - "@rushstack/rig-package": "0.3.17", - "@rushstack/ts-command-line": "4.13.1", + "@rushstack/node-core-library": "3.61.0", + "@rushstack/rig-package": "0.5.1", + "@rushstack/ts-command-line": "4.16.1", "colors": "~1.2.1", "lodash": "~4.17.15", - "resolve": "~1.17.0", - "semver": "~7.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "source-map": "~0.6.1", - "typescript": "~4.8.4" + "typescript": "~5.0.4" }, "dependencies": { "typescript": { - "version": "4.8.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz", - "integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==", + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", + "integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==", "dev": true } } }, "@microsoft/api-extractor-model": { - "version": "7.25.3", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.25.3.tgz", - "integrity": "sha512-WWxBUq77p2iZ+5VF7Nmrm3y/UtqCh5bYV8ii3khwq3w99+fXWpvfsAhgSLsC7k8XDQc6De4ssMxH6He/qe1pzg==", + "version": "7.28.2", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.2.tgz", + "integrity": "sha512-vkojrM2fo3q4n4oPh4uUZdjJ2DxQ2+RnDQL/xhTWSRUNPF6P4QyrvY357HBxbnltKcYu+nNNolVqc6TIGQ73Ig==", "dev": true, "requires": { "@microsoft/tsdoc": "0.14.2", "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "3.53.3" + "@rushstack/node-core-library": "3.61.0" } }, "@microsoft/tsdoc": { @@ -5291,43 +5270,34 @@ } }, "@rushstack/node-core-library": { - "version": "3.53.3", - "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.53.3.tgz", - "integrity": "sha512-H0+T5koi5MFhJUd5ND3dI3bwLhvlABetARl78L3lWftJVQEPyzcgTStvTTRiIM5mCltyTM8VYm6BuCtNUuxD0Q==", + "version": "3.61.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.61.0.tgz", + "integrity": "sha512-tdOjdErme+/YOu4gPed3sFS72GhtWCgNV9oDsHDnoLY5oDfwjKUc9Z+JOZZ37uAxcm/OCahDHfuu2ugqrfWAVQ==", "dev": true, "requires": { - "@types/node": "12.20.24", "colors": "~1.2.1", "fs-extra": "~7.0.1", "import-lazy": "~4.0.0", "jju": "~1.4.0", - "resolve": "~1.17.0", - "semver": "~7.3.0", + "resolve": "~1.22.1", + "semver": "~7.5.4", "z-schema": "~5.0.2" - }, - "dependencies": { - "@types/node": { - "version": "12.20.24", - "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", - "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", - "dev": true - } } }, "@rushstack/rig-package": { - "version": "0.3.17", - "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.17.tgz", - "integrity": "sha512-nxvAGeIMnHl1LlZSQmacgcRV4y1EYtgcDIrw6KkeVjudOMonlxO482PhDj3LVZEp6L7emSf6YSO2s5JkHlwfZA==", + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.5.1.tgz", + "integrity": "sha512-pXRYSe29TjRw7rqxD4WS3HN/sRSbfr+tJs4a9uuaSIBAITbUggygdhuG0VrO0EO+QqH91GhYMN4S6KRtOEmGVA==", "dev": true, "requires": { - "resolve": "~1.17.0", + "resolve": "~1.22.1", "strip-json-comments": "~3.1.1" } }, "@rushstack/ts-command-line": { - "version": "4.13.1", - "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.13.1.tgz", - "integrity": "sha512-UTQMRyy/jH1IS2U+6pyzyn9xQ2iMcoUKkTcZUzOP/aaMiKlWLwCTDiBVwhw/M1crDx6apF9CwyjuWO9r1SBdJQ==", + "version": "4.16.1", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.16.1.tgz", + "integrity": "sha512-+OCsD553GYVLEmz12yiFjMOzuPeCiZ3f8wTiFHL30ZVXexTyPmgjwXEhg2K2P0a2lVf+8YBy7WtPoflB2Fp8/A==", "dev": true, "requires": { "@types/argparse": "1.0.38", @@ -5905,9 +5875,9 @@ } }, "commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "version": "9.5.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", + "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", "dev": true, "optional": true }, @@ -6527,9 +6497,9 @@ "dev": true }, "get-func-name": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", - "integrity": "sha512-Hm0ixYtaSZ/V7C8FJrtZIuBBI+iSgL+1Aq82zSu8VQNB4S3Gk8e7Qs3VwBDJAhmRZcFqkl3tQu36g/Foh5I5ig==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.2.tgz", + "integrity": "sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==", "dev": true }, "get-intrinsic": { @@ -6620,9 +6590,9 @@ } }, "graceful-fs": { - "version": "4.2.10", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", - "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", "dev": true }, "graphemer": { @@ -6781,9 +6751,9 @@ "dev": true }, "is-core-module": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.11.0.tgz", - "integrity": "sha512-RRjxlvLDkD1YJwDbroBHMb+cukurkDWNyHx7D3oNB5x9rb5ogcksMC5wHCadcXoo67gVr/+3GFySh3134zi6rw==", + "version": "2.13.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.0.tgz", + "integrity": "sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ==", "dev": true, "requires": { "has": "^1.0.3" @@ -7404,9 +7374,9 @@ } }, "postcss": { - "version": "8.4.25", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.25.tgz", - "integrity": "sha512-7taJ/8t2av0Z+sQEvNzCkpDynl0tX3uJMCODi6nT3PfASC7dYCWV9aQ+uiCf+KBD4SEFcu+GvJdGdwzQ6OSjCw==", + "version": "8.4.31", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.31.tgz", + "integrity": "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==", "dev": true, "requires": { "nanoid": "^3.3.6", @@ -7500,12 +7470,14 @@ "dev": true }, "resolve": { - "version": "1.17.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "version": "1.22.6", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.6.tgz", + "integrity": "sha512-njhxM7mV12JfufShqGy3Rz8j11RPdLy4xi15UurGJeoHLfJpVXKdh3ueuOqbYUcDZnffr6X739JBo5LzyahEsw==", "dev": true, "requires": { - "path-parse": "^1.0.6" + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" } }, "resolve-from": { @@ -7578,9 +7550,9 @@ "integrity": "sha512-dVHE6bMtS/bnL2mwualjc6IxEv1F+OCUpA46pKUj6F8uDbUM0jCCulPqRNPSnWwGNKx5etqMjZYdXtrm5KJZGA==" }, "semver": { - "version": "7.3.8", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", - "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", "dev": true, "requires": { "lru-cache": "^6.0.0" @@ -7708,9 +7680,9 @@ } }, "string-argv": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", - "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz", + "integrity": "sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==", "dev": true }, "string.prototype.trim": { @@ -8013,9 +7985,9 @@ "dev": true }, "validator": { - "version": "13.7.0", - "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", - "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz", + "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==", "dev": true }, "vite": { @@ -8193,12 +8165,12 @@ "dev": true }, "z-schema": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.4.tgz", - "integrity": "sha512-gm/lx3hDzJNcLwseIeQVm1UcwhWIKpSB4NqH89pTBtFns4k/HDHudsICtvG05Bvw/Mv3jMyk700y5dadueLHdA==", + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", + "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", "dev": true, "requires": { - "commander": "^2.20.3", + "commander": "^9.4.1", "lodash.get": "^4.4.2", "lodash.isequal": "^4.5.0", "validator": "^13.7.0" diff --git a/package.json b/package.json index 07d804d4..519006e1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@holochain/tryorama", "description": "Toolset to manage Holochain conductors and facilitate running test scenarios", - "version": "0.15.0", + "version": "0.15.1", "author": "Holochain Foundation", "keywords": [ "holochain", diff --git a/ts/src/types.ts b/ts/src/types.ts index 6ca363bb..66950704 100644 --- a/ts/src/types.ts +++ b/ts/src/types.ts @@ -204,6 +204,8 @@ export interface Dna { /** * A Conductor and a CellId + * + * @public */ export interface IConductorCell { conductor: IConductor;