@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
35 lines • 102 kB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Journey | Frodo Library - v3.1.0</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Frodo Library - v3.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Frodo Library</a></li><li><a href="../modules/Reference.html">Reference</a></li><li><a href="Reference.Journey.html">Journey</a></li></ul><h1>Type Alias Journey</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Journey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">fileByIdTreeExportResolver</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">onlineTreeExportResolver</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createFileParamTreeExportResolver</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">journeyData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createMultiTreeExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MultiTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">MultiTreeExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createSingleTreeExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">deep</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">progress</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">verbose</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.DeleteJourneyStatus.html" class="tsd-signature-type tsd-kind-type-alias">DeleteJourneyStatus</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteJourneys</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">deep</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">verbose</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.DeleteJourneysStatus.html" class="tsd-signature-type tsd-kind-type-alias">DeleteJourneysStatus</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">disableJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">enableJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">treeId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.TreeExportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeExportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportJourneys</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.TreeExportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeExportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.MultiTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">MultiTreeExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">findOrphanedNodes</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.NodeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">NodeSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getJourneyClassification</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">journey</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Reference.JourneyClassificationType.html" class="tsd-signature-type tsd-kind-type-alias">JourneyClassificationType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getJourneys</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getNodeRef</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nodeObj</span><span class="tsd-signature-symbol">:</span> <a href="Reference.NodeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">NodeSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">singleTreeExport</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.NodeRefSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">NodeRefSkeletonInterface</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/Reference.InnerNodeRefSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">InnerNodeRefSkeletonInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getTreeDescendents</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">treeExport</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resolveTreeExport</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resolvedTreeIds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.TreeDependencyMapInterface.html" class="tsd-signature-type tsd-kind-interface">TreeDependencyMapInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importAllJourneys</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MultiTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">MultiTreeExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeImportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeImportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">treeObject</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeImportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeImportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importJourneys</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MultiTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">MultiTreeExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeImportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeImportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">isCloudOnlyJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journey</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">isCustomJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journey</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">isPremiumJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journey</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readJourneys</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">removeOrphanedNodes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">orphanedNodes</span><span class="tsd-signature-symbol">:</span> <a href="Reference.NodeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">NodeSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.NodeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">NodeSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">resolveDependencies</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">installedJorneys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">journeyMap</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">unresolvedJourneys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resolvedJourneys</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">journeyData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">fileByIdTreeExportResolver</span><a id="__typefilebyidtreeexportresolver" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a></h5><div class="tsd-comment tsd-typography"><p>Tree export resolver used to resolve a tree id/name to a full export
of that tree from individual <code>treename.journey.json</code> export files.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-treeid" class="tsd-anchor"></a>Param: treeId<a href="#param-treeid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>id/name of the tree to resolve</p>
</div><div class="tsd-tag-returns"><h4 class="tsd-anchor-link"><a id="returns" class="tsd-anchor"></a>Returns<a href="#returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>tree export</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">onlineTreeExportResolver</span><a id="__typeonlinetreeexportresolver" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a></h5><div class="tsd-comment tsd-typography"><p>Default tree export resolver used to resolve a tree id/name to a full export
w/o dependencies of that tree from a platform instance.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-treeid-1" class="tsd-anchor"></a>Param: treeId<a href="#param-treeid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>id/name of the tree to resolve</p>
</div><div class="tsd-tag-returns"><h4 class="tsd-anchor-link"><a id="returns-1" class="tsd-anchor"></a>Returns<a href="#returns-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>tree export</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createFileParamTreeExportResolver</span><a id="__typecreatefileparamtreeexportresolver" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatefileparamtreeexportresolver-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createFileParamTreeExportResolver</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a><a href="#__typecreatefileparamtreeexportresolver-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Factory that creates a tree export resolver used to resolve a tree id
to a full export of that tree from a multi-tree export file.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>multi-tree export file</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.TreeExportResolverInterface.html" class="tsd-signature-type tsd-kind-interface">TreeExportResolverInterface</a></h4><p>tree export resolver</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L220">ops/JourneyOps.ts:220</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createJourney</span><a id="__typecreatejourney" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatejourney-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">journeyData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreatejourney-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create journey without dependencies.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">journeyId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>journey id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">journeyData</span>: <a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a journey object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L137">ops/JourneyOps.ts:137</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createMultiTreeExportTemplate</span><a id="__typecreatemultitreeexporttemplate" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatemultitreeexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createMultiTreeExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MultiTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">MultiTreeExportInterface</a><a href="#__typecreatemultitreeexporttemplate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create an empty multi tree export template</p>
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.MultiTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">MultiTreeExportInterface</a></h4><p>an empty multi tree export template</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L102">ops/JourneyOps.ts:102</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createSingleTreeExportTemplate</span><a id="__typecreatesingletreeexporttemplate" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatesingletreeexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createSingleTreeExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><a href="#__typecreatesingletreeexporttemplate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create an empty single tree export template</p>
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a></h4><p>an empty single tree export template</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L97">ops/JourneyOps.ts:97</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteJourney</span><a id="__typedeletejourney" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedeletejourney-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">deep</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">progress</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">verbose</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.DeleteJourneyStatus.html" class="tsd-signature-type tsd-kind-type-alias">DeleteJourneyStatus</a><span class="tsd-signature-symbol">></span><a href="#__typedeletejourney-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete a journey</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">journeyId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>journey id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">deep</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">progress</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">verbose</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>deep=true also delete all the nodes and inner nodes, verbose=true print verbose info</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.DeleteJourneyStatus.html" class="tsd-signature-type tsd-kind-type-alias">DeleteJourneyStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L268">ops/JourneyOps.ts:268</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteJourneys</span><a id="__typedeletejourneys" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedeletejourneys-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteJourneys</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">deep</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">verbose</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.DeleteJourneysStatus.html" class="tsd-signature-type tsd-kind-type-alias">DeleteJourneysStatus</a><span class="tsd-signature-symbol">></span><a href="#__typedeletejourneys-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete all journeys</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">deep</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">verbose</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>deep=true also delete all the nodes and inner nodes, verbose=true print verbose info</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.DeleteJourneysStatus.html" class="tsd-signature-type tsd-kind-type-alias">DeleteJourneysStatus</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L280">ops/JourneyOps.ts:280</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">disableJourney</span><a id="__typedisablejourney" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedisablejourney-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disableJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedisablejourney-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disable a journey</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">journeyId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>journey id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>the updated tree/journey object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L295">ops/JourneyOps.ts:295</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">enableJourney</span><a id="__typeenablejourney" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeenablejourney-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enableJourney</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">journeyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeenablejourney-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enable a journey</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">journeyId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>journey id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.TreeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">TreeSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>the updated tree/journey object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L289">ops/JourneyOps.ts:289</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportJourney</span><a id="__typeexportjourney" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexportjourney-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportJourney</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">treeId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.TreeExportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeExportOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportjourney-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create export data for a tree/journey with all its nodes and dependencies. The export data can be written to a file as is.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">treeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>tree id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.TreeExportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.SingleTreeExportInterface.html" class="tsd-signature-type tsd-kind-interface">SingleTreeExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an object containing the tree and all its nodes and dependencies</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/JourneyOps.ts#L109">ops/JourneyOps.ts:109</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportJourneys</span><a id="__typeexportjourneys" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexportjourneys-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportJourneys</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.TreeExportOptions.html" class="tsd-signature-type tsd-kind-interface">TreeExportOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signat