@deep-foundation/deeplinks
Version:
[](https://www.npmjs.com/package/@deep-foundation/deeplinks) [](https://gitpod.io/#https://github.com/deep-fo
40 lines (32 loc) • 42.3 kB
HTML
<html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Package | @deep-foundation/deeplinks</title><meta name="description" content="Documentation for @deep-foundation/deeplinks"/><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">@deep-foundation/deeplinks</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="../modules.html">@deep-foundation/deeplinks</a></li><li><a href="../modules/package.html">package</a></li><li><a href="package.Package.html">Package</a></li></ul><h1>Class Package</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a deep package</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Remarks"><h4 class="tsd-anchor-link"><a id="Remarks" class="tsd-anchor"></a>Remarks<a href="#Remarks" 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>This class intended to be extended by packages</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-3">const</span><span class="hl-2"> </span><span class="hl-7">package</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-1">Package</span><span class="hl-2">({</span><span class="hl-6">deep</span><span class="hl-2">, </span><span class="hl-6">name</span><span class="hl-2">});</span><br/><span class="hl-3">const</span><span class="hl-2"> {</span><span class="hl-6">name</span><span class="hl-2">: </span><span class="hl-7">packageName</span><span class="hl-2">} = </span><span class="hl-6">package</span><span class="hl-2">;</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">batteryLevelValueLinkId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">package</span><span class="hl-2">.</span><span class="hl-6">batteryLevelValue</span><span class="hl-2">.</span><span class="hl-1">id</span><span class="hl-2">();</span>
</code><button type="button">Copy</button></pre>
</div></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L19">work/deeplinks/deeplinks/imports/package.ts:19</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="package.Package.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="package.Package.html#deep" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deep</span></a>
<a href="package.Package.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="package.Package.html#applyMiniLinks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Mini<wbr/>Links</span></a>
<a href="package.Package.html#createEntity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Entity</span></a>
<a href="package.Package.html#id-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>id</span></a>
<a href="package.Package.html#idLocal-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>id<wbr/>Local</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Package" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Package</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="package.Package.html" class="tsd-signature-type tsd-kind-class">Package</a><a href="#constructor.new_Package" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/package.PackageOptions.html" class="tsd-signature-type tsd-kind-interface">PackageOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="package.Package.html" class="tsd-signature-type tsd-kind-class">Package</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L26">work/deeplinks/deeplinks/imports/package.ts:26</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="deep" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>deep</span><a href="#deep" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deep</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/client.DeepClientInstance.html" class="tsd-signature-type tsd-kind-interface">DeepClientInstance</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><span class="tsd-signature-symbol"><</span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L20">work/deeplinks/deeplinks/imports/package.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of the package</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L24">work/deeplinks/deeplinks/imports/package.ts:24</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="applyMiniLinks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply<wbr/>Mini<wbr/>Links</span><a href="#applyMiniLinks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="applyMiniLinks.applyMiniLinks-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">apply<wbr/>Mini<wbr/>Links</span><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><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">anomalies</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/minilinks.MinilinkError.html" class="tsd-signature-type tsd-kind-interface">MinilinkError</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><span class="tsd-signature-symbol"><</span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">errors</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/minilinks.MinilinkError.html" class="tsd-signature-type tsd-kind-interface">MinilinkError</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">plainLinks</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><span class="tsd-signature-symbol"><</span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></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><a href="#applyMiniLinks.applyMiniLinks-1" 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>Pastes your links into minilinks</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">anomalies</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/minilinks.MinilinkError.html" class="tsd-signature-type tsd-kind-interface">MinilinkError</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><span class="tsd-signature-symbol"><</span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">errors</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/minilinks.MinilinkError.html" class="tsd-signature-type tsd-kind-interface">MinilinkError</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">plainLinks</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><span class="tsd-signature-symbol"><</span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></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></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><a id="md:use-applyminilinks-and-idlocal" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Use applyMiniLinks and idLocal<a href="#md:use-applyminilinks-and-idlocal" 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-3">const</span><span class="hl-2"> </span><span class="hl-7">package</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-1">Package</span><span class="hl-2">({</span><span class="hl-6">deep</span><span class="hl-2">});</span><br/><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">package</span><span class="hl-2">.</span><span class="hl-1">applyMiniLinks</span><span class="hl-2">();</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">deviceLinkId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">package</span><span class="hl-2">.</span><span class="hl-6">Device</span><span class="hl-2">.</span><span class="hl-1">idLocal</span><span class="hl-2">();</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L141">work/deeplinks/deeplinks/imports/package.ts:141</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="createEntity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Entity</span><a href="#createEntity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createEntity.createEntity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Entity</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><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><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="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">idLocal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</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><a href="#createEntity.createEntity-1" 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>Creates an entity</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">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><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="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">idLocal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">name</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></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><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="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Gets id of the link</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-2" class="tsd-anchor"></a>Example<a href="#Example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><a id="md:get-id-of-the-link" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Get id of the link<a href="#md:get-id-of-the-link" 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-3">const</span><span class="hl-2"> </span><span class="hl-7">myPackage</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-1">MyPackage</span><span class="hl-2">({</span><span class="hl-6">deep</span><span class="hl-2">});</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myLinkId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">myPackage</span><span class="hl-2">.</span><span class="hl-6">yourLinkName</span><span class="hl-2">.</span><span class="hl-1">id</span><span class="hl-2">();</span>
</code><button type="button">Copy</button></pre>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createEntity.createEntity-1.__type.id.__type-1.__type-2"><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="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">id<wbr/>Local</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Gets id of the link from minilinks</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-3" class="tsd-anchor"></a>Example<a href="#Example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><a id="md:get-id-of-the-link-from-minilinks" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Get id of the link from minilinks<a href="#md:get-id-of-the-link-from-minilinks" 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-3">const</span><span class="hl-2"> </span><span class="hl-7">myPackage</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-1">MyPackage</span><span class="hl-2">({</span><span class="hl-6">deep</span><span class="hl-2">});</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myLinkLocalId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">myPackage</span><span class="hl-2">.</span><span class="hl-6">yourLinkName</span><span class="hl-2">.</span><span class="hl-1">idLocal</span><span class="hl-2">();</span>
</code><button type="button">Copy</button></pre>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createEntity.createEntity-1.__type.idLocal.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Name of the link</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-4" class="tsd-anchor"></a>Example<a href="#Example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><a id="md:create-an-entity" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Create an entity<a href="#md:create-an-entity" 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-3">class</span><span class="hl-2"> </span><span class="hl-10">MyPackage</span><span class="hl-2"> </span><span class="hl-3">extends</span><span class="hl-2"> </span><span class="hl-10">Package</span><span class="hl-2"> {</span><br/><span class="hl-3">public</span><span class="hl-2"> </span><span class="hl-6">yourLinkName</span><span class="hl-2"> = </span><span class="hl-3">this</span><span class="hl-2">.</span><span class="hl-1">createEntity</span><span class="hl-2">(</span><span class="hl-4">"YourLinkName"</span><span class="hl-2">);</span><br/><span class="hl-2">}</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myPackage</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-1">MyPackage</span><span class="hl-2">({</span><span class="hl-6">deep</span><span class="hl-2">});</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myLinkId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">myPackage</span><span class="hl-2">.</span><span class="hl-6">yourLinkName</span><span class="hl-2">.</span><span class="hl-1">id</span><span class="hl-2">();</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myLinkLocalId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">myPackage</span><span class="hl-2">.</span><span class="hl-6">yourLinkName</span><span class="hl-2">.</span><span class="hl-1">idLocal</span><span class="hl-2">();</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L47">work/deeplinks/deeplinks/imports/package.ts:47</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="id-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="id-1.id-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">names</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="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span><a href="#id-1.id-2" 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>Gets id of the package link</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">names</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></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="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-5" class="tsd-anchor"></a>Example<a href="#Example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><a id="md:get-id-of-the-package-link" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Get id of the package link<a href="#md:get-id-of-the-package-link" 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-3">const</span><span class="hl-2"> </span><span class="hl-7">package</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-1">Package</span><span class="hl-2">({</span><span class="hl-6">deep</span><span class="hl-2">});</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myLinkId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">package</span><span class="hl-2">.</span><span class="hl-1">id</span><span class="hl-2">(</span><span class="hl-4">"MyLinkName"</span><span class="hl-2">);</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L99">work/deeplinks/deeplinks/imports/package.ts:99</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="idLocal-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id<wbr/>Local</span><a href="#idLocal-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="idLocal-1.idLocal-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">id<wbr/>Local</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">names</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a><a href="#idLocal-1.idLocal-2" 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>Gets id of the package link from minilinks</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">names</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-6" class="tsd-anchor"></a>Example<a href="#Example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><a id="md:get-id-of-the-package-link-from-minilinks" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Get id of the package link from minilinks<a href="#md:get-id-of-the-package-link-from-minilinks" 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-3">const</span><span class="hl-2"> </span><span class="hl-7">package</span><span class="hl-2"> = </span><span class="hl-3">new</span><span class="hl-2"> </span><span class="hl-1">Package</span><span class="hl-2">({</span><span class="hl-6">deep</span><span class="hl-2">});</span><br/><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">package</span><span class="hl-2">.</span><span class="hl-1">applyMiniLinks</span><span class="hl-2">();</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myLinkId</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">package</span><span class="hl-2">.</span><span class="hl-1">idLocal</span><span class="hl-2">(</span><span class="hl-4">"MyLinkName"</span><span class="hl-2">);</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/deep-foundation/deeplinks/blob/381207dda313ab3c1fed0a4bfc2ddbe631750411/imports/package.ts#L120">work/deeplinks/deeplinks/imports/package.ts:120</a></li></ul></aside></li></ul></section></section></details></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><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#deep" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deep</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#applyMiniLinks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Mini<wbr/>Links</span></a><ul><li><ul><li><ul><li><ul><li><a href="#md:use-applyminilinks-and-idlocal"><span>Use apply<wbr/>Mini<wbr/>Links and id<wbr/>Local</span></a></li></ul></li></ul></li></ul></li></ul><a href="#createEntity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Entity</span></a><ul><li><ul><li><ul><li><ul><li><a href="#md:get-id-of-the-link"><span>Get id of the link</span></a></li><li><a href="#md:get-id-of-the-link-from-minilinks"><span>Get id of the link from minilinks</span></a></li><li><a href="#md:create-an-entity"><span>Create an entity</span></a></li></ul></li></ul></li></ul></li></ul><a href="#id-1" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>id</span></a><ul><li><ul><li><ul><li><ul><li><a href="#md:get-id-of-the-package-link"><span>Get id of the package link</span></a></li></ul></li></ul></li></ul></li></ul><a href="#idLocal-1" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>id<wbr/>Local</span></a><ul><li><a href="#md:get-id-of-the-package-link-from-minilinks"><span>Get id of the package link from minilinks</span></a></li></ul></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@deep-foundation/deeplinks</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>