@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
58 lines (55 loc) • 61.2 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>Variable | 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.Variable.html">Variable</a></li></ul><h1>Type Alias Variable</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Variable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportVariables</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getVariables</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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">importVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importVariables</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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">putVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">valueBase64</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readVariables</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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">setVariableDescription</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">description</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateVariableDescription</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">description</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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-method">createVariable</span><a id="__typecreatevariable" 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="__typecreatevariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreatevariable-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 variable</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable value</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable description</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">expressionType</span>: <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a></span><div class="tsd-comment tsd-typography"><p>type of the value</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noEncode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>do not encode if passing a pre-encoded (base64) value</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable 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/cloud/VariablesOps.ts#L82">ops/cloud/VariablesOps.ts:82</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteVariable</span><a id="__typedeletevariable" 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="__typedeletevariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeletevariable-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 variable by id/name</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable 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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable 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/cloud/VariablesOps.ts#L120">ops/cloud/VariablesOps.ts:120</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportVariable</span><a id="__typeexportvariable" 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="__typeexportvariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportvariable-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>Export variable. The response can be saved to 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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable 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">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode value (default: false)</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a VariablesExportInterface 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/cloud/VariablesOps.ts#L45">ops/cloud/VariablesOps.ts:45</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportVariables</span><a id="__typeexportvariables" 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="__typeexportvariables-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportVariables</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportvariables-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>Export all variables</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode values (default: false)</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an VariablesExportInterface 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/cloud/VariablesOps.ts#L54">ops/cloud/VariablesOps.ts:54</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getVariable</span><a id="__typegetvariable" 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="__typegetvariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typegetvariable-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>Get variable by id/name</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable 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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable object</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" 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>since v2.0.0 use <a href="Reference.Variable.html#__typereadvariable" class="tsd-kind-method">readVariable</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readVariable</span><span class="hl-0">(</span><span class="hl-3">variableId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">VariableSkeleton</span><span class="hl-0">></span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/VariablesOps.ts#L134">ops/cloud/VariablesOps.ts:134</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getVariables</span><a id="__typegetvariables" 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="__typegetvariables-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getVariables</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typegetvariables-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>Get all variables</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of variable objects</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-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>since v2.0.0 use <a href="Reference.Variable.html#__typereadvariables" class="tsd-kind-method">readVariables</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readVariables</span><span class="hl-0">(): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">VariableSkeleton</span><span class="hl-0">[]></span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/VariablesOps.ts#L144">ops/cloud/VariablesOps.ts:144</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importVariable</span><a id="__typeimportvariable" 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="__typeimportvariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportvariable-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>Import variable by id</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>imported variable 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/cloud/VariablesOps.ts#L61">ops/cloud/VariablesOps.ts:61</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importVariables</span><a id="__typeimportvariables" 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="__typeimportvariables-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importVariables</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportvariables-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>Import variables</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">importData</span>: <a href="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>array of imported variable objects</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/cloud/VariablesOps.ts#L70">ops/cloud/VariablesOps.ts:70</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">putVariable</span><a id="__typeputvariable" 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="__typeputvariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">putVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">valueBase64</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeputvariable-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 variable</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">valueBase64</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>base64-encoded variable value</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable description</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">expressionType</span>: <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a></span><div class="tsd-comment tsd-typography"><p>type of the value</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable object</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#deprecated-2" 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>since v2.0.0 use <a href="Reference.Variable.html#__typecreatevariable" class="tsd-kind-method">createVariable</a> instead</p>
<pre><code class="javascript"><span class="hl-7">createVariable</span><span class="hl-0">(</span><span class="hl-3">variableId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">value</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">description</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">expressionType</span><span class="hl-0">?: </span><span class="hl-3">VariableExpressionType</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">VariableSkeleton</span><span class="hl-0">></span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/VariablesOps.ts#L158">ops/cloud/VariablesOps.ts:158</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readVariable</span><a id="__typereadvariable" 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="__typereadvariable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">noDecode</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereadvariable-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>Read variable by id/name</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable 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">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode value (default: false)</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable 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/cloud/VariablesOps.ts#L29">ops/cloud/VariablesOps.ts:29</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readVariables</span><a id="__typereadvariables" 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="__typereadvariables-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readVariables</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadvariables-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>Read all variables</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode values (default: false)</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of variable objects</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/cloud/VariablesOps.ts#L38">ops/cloud/VariablesOps.ts:38</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">setVariableDescription</span><a id="__typesetvariabledescription" 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="__typesetvariabledescription-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setVariableDescription</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#__typesetvariabledescription-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>Set variable description</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable description</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><s