CINXE.COM

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>lazySafeGetInst | @nevware21/ts-utils</title><meta name="description" content="Documentation for @nevware21/ts-utils"/><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></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" data-base=".."><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"><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"></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">@nevware21/ts-utils</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"><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="../index.html">@nevware21/ts-utils</a></li><li><a href="lazySafeGetInst.html">lazySafeGetInst</a></li></ul><h1>Function lazySafeGetInst</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="lazySafeGetInst" class="tsd-anchor"></a><span class="tsd-kind-call-signature">lazy<wbr/>Safe<wbr/>Get<wbr/>Inst</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="lazySafeGetInst.html#lazySafeGetInst.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ILazyValue.html" class="tsd-signature-type tsd-kind-interface">ILazyValue</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="lazySafeGetInst.html#lazySafeGetInst.T">T</a><span class="tsd-signature-symbol">></span><a href="#lazySafeGetInst" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create and return an readonly <a href="../interfaces/ILazyValue.html" class="tsd-kind-interface">ILazyValue</a> instance which will cache and return the named global value if available, will return <code>null</code> if the named global object is not available or if the runtime throws an exception when attempting to access the global object. Unlike <a href="getInst.html" class="tsd-kind-function">getInst</a> the value is cached after the first access, so if the global value changes after the initial fetch the original cached value is still returned.</p> </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="lazySafeGetInst.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The name of the global object to get, may be any valid PropertyKey (string, number or symbol)</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/ILazyValue.html" class="tsd-signature-type tsd-kind-interface">ILazyValue</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="lazySafeGetInst.html#lazySafeGetInst.T">T</a><span class="tsd-signature-symbol">></span></h4><p>A new readonly <a href="../interfaces/ILazyValue.html" class="tsd-kind-interface">ILazyValue</a> instance which will lazily attempt to return the globally available named instance.</p> <div class="tsd-comment tsd-typography"><div class="tsd-tag-Since"><h4 class="tsd-anchor-link"><a id="Since" class="tsd-anchor"></a>Since<a href="#Since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>0.9.5</p> </div><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">// This does not cause the evaluation to occur</span><br/><span class="hl-2">window</span><span class="hl-1">.</span><span class="hl-2">myGlobal</span><span class="hl-1"> = </span><span class="hl-5">"Hello"</span><span class="hl-1">;</span><br/><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-2">cachedValue</span><span class="hl-1"> = </span><span class="hl-3">lazySafeGetInst</span><span class="hl-1">(</span><span class="hl-5">"myGlobal"</span><span class="hl-1">);</span><br/><span class="hl-6">// cachedValue.v === "Hello"</span><br/><br/><span class="hl-2">window</span><span class="hl-1">.</span><span class="hl-2">myGlobal</span><span class="hl-1"> = </span><span class="hl-5">"Darkness"</span><span class="hl-1">;</span><br/><span class="hl-6">// cachedValue.v === "Hello"</span><br/><br/><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-2">promiseCls</span><span class="hl-1"> = </span><span class="hl-3">lazySafeGetInst</span><span class="hl-1">(</span><span class="hl-5">"Promise"</span><span class="hl-1">);</span><br/><span class="hl-6">// null if Promise is not supported in the runtime</span><br/><span class="hl-6">// otherwise the Promise class.</span> </code><button type="button">Copy</button></pre> </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/nevware21/ts-utils/blob/main/lib/src/helpers/environment.ts#L71">lib/src/helpers/environment.ts:71</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@nevware21/ts-utils</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>