@deep-foundation/deeplinks
Version:
[](https://www.npmjs.com/package/@deep-foundation/deeplinks) [](https://gitpod.io/#https://github.com/deep-fo
20 lines (14 loc) • 30.3 kB
HTML
<html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@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"><h1>@deep-foundation/deeplinks</h1></div><div class="tsd-panel tsd-typography"><p><a href="https://www.npmjs.com/package/@deep-foundation/deeplinks" target="_blank" class="external"><img src="https://img.shields.io/npm/v/@deep-foundation/deeplinks.svg" alt="npm"></a>
<a href="https://gitpod.io/#https://github.com/deep-foundation/deeplinks" target="_blank" class="external"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" alt="Gitpod"></a>
<a href="https://discord.gg/deep-foundation" target="_blank" class="external"><img src="https://badgen.net/badge/icon/discord?icon=discord&label&color=purple" alt="Discord"></a></p>
<a id="md:documentation" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Documentation<a href="#md:documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><a id="md:container-and-cli" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Container and CLI<a href="#md:container-and-cli" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-0"># generate deep. config json</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--generate</span><br/><span class="hl-0"># by default auto detect public ip or gitpod urls (gitpod too)</span><br/><span class="hl-0"># manual config</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--generate</span><span class="hl-2"> </span><span class="hl-3">--deeplinks=</span><span class="hl-4">"https://links.my-domain.io"</span><span class="hl-2"> </span><span class="hl-3">--perception=</span><span class="hl-4">"https://peception.my-domain.io"</span><br/><span class="hl-0"># update and running all containers empty, without links, available for migrations</span><br/><span class="hl-1">nрх</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--up</span><br/><span class="hl-0"># apply snapshot generated in gh-actions with basic links and packages</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--snapshot</span><br/><span class="hl-0"># down all containers without removind data from values</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--down</span><br/><span class="hl-0"># down and up with updating docker images in sequence</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--down</span><span class="hl-2"> </span><span class="hl-3">--up</span><br/><br/><span class="hl-0"># exec js interactive terminal with deep in variables context</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--exec</span><br/><span class="hl-2">> deep </span><span class="hl-0"># DeepClient</span><br/><span class="hl-0"># instead of using snapshot, do manual migration</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--migrate</span><br/><span class="hl-0"># unmigrate</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--unmigrate</span><br/><span class="hl-0"># print all envs</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--envs</span><br/><span class="hl-0"># exec bash script in envs based on deep.config json in deeplinks directory, for example stop all containers</span><br/><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-3">-y</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--bash=</span><span class="hl-4">"docker compose -p deep down"</span>
</code><button type="button">Copy</button></pre>
<a id="md:imports" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Imports<a href="#md:imports" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="ts"><span class="hl-5">import</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">useDeep</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepProvider</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useDeepGenerator</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClient</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepContext</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepNamespaceProvider</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepNamespaceContext</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useDeepNamespaces</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useDeepNamespace</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useTransparentState</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useDebouncedInput</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useDeepQuery</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useDeepSubscription</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useDeepId</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useSearch</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useAuthNode</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useLink</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useLinks</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">random</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">parseJwt</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">serializeQuery</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">serializeWhere</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">pathToWhere</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Handler</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Subscription</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Observer</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientResult</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepSearchOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientInstance</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientAuthResult</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientGuestOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientJWTOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">UseDeepSubscriptionResult</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientPackageSelector</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientPackageContain</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientLinkId</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientStartItem</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepClientPathItem</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">SelectTable</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">InsertTable</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">UpdateTable</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeleteTable</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">OperationType</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">SerialOperationType</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Table</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ValueForTable</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ExpForTable</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">SerialOperationDetails</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">SerialOperation</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">DeepSerialOperation</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">AsyncSerialParams</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">INamespaces</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Exp</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">UpdateValue</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">InsertObjects</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Options</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ReadOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">WriteOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksLink</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinkCollection</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">minilinks</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksContext</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">toPlain</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Minilinks</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinksConstruct</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinksFilter</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinksHandle</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinksApply</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinksQuery</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinksSubscription</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinksGenerator</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksProvider</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useMinilinks</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Links</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">LinkPlain</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">LinkRelations</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">LinkHashFields</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Link</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksQueryOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksResult</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksGeneratorOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksInstance</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinkError</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ApplyReturnOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ApplyOptions</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksHookInstance</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Id</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksQueryOptionAggregate</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MinilinksApplyInput</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useTokenController</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">TokenProvider</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">QueryLink</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">QueryLinkReturn</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">BoolExp</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ReturnBoolExp</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">BoolExpLink</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">BoolExpValue</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">BoolExpCan</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">BoolExpSelector</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">BoolExpTree</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">BoolExpHandler</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ComparasionExp</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MutationInput</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MutationInputLinkPlain</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MutationInputLink</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">MutationInputValue</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">Query</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">LinkToLinksRelations</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ComparasionType</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">CatchErrors</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">evalClientHandler</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">useFindClientHandler</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ClientHandler</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ClientHandlerRenderer</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ClientHandlerRendererProps</span><span class="hl-2">, </span><br/><span class="hl-2"> </span><span class="hl-6">ClientHandlerProps</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">Packages</span><span class="hl-2">,</span><br/><span class="hl-2">} </span><span class="hl-5">from</span><span class="hl-2"> </span><span class="hl-4">"@deep-foundation/deeplinks"</span><span class="hl-2">;</span>
</code><button type="button">Copy</button></pre>
<a id="md:manual-exportimport-packages-from-admin-without-using-npm" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Manual export/import packages from admin, without using npm<a href="#md:manual-exportimport-packages-from-admin-without-using-npm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="js"><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">dc</span><span class="hl-2"> = </span><span class="hl-4">'@deep-foundation/core'</span><span class="hl-2">;</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">myPackageId</span><span class="hl-2"> = </span><span class="hl-8">1850</span><span class="hl-2">;</span><br/><span class="hl-0">// If you just created Package without PackageVersion and PackageNamespace</span><br/><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">deep</span><span class="hl-2">.</span><span class="hl-1">insert</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-6">type_id:</span><span class="hl-2"> </span><span class="hl-6">deep</span><span class="hl-2">.</span><span class="hl-1">idLocal</span><span class="hl-2">(</span><span class="hl-6">dc</span><span class="hl-2">, </span><span class="hl-4">'PackageVersion'</span><span class="hl-2">),</span><br/><span class="hl-2"> </span><span class="hl-6">from:</span><span class="hl-2"> { </span><span class="hl-6">type_id:</span><span class="hl-2"> </span><span class="hl-6">deep</span><span class="hl-2">.</span><span class="hl-1">idLocal</span><span class="hl-2">(</span><span class="hl-6">dc</span><span class="hl-2">, </span><span class="hl-4">'PackageNamespace'</span><span class="hl-2">) },</span><br/><span class="hl-2"> </span><span class="hl-6">to_id:</span><span class="hl-2"> </span><span class="hl-6">myPackageId</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">string:</span><span class="hl-2"> </span><span class="hl-4">'0.0.1'</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">packager</span><span class="hl-2"> = </span><span class="hl-6">deep</span><span class="hl-2">.</span><span class="hl-1">Packager</span><span class="hl-2">();</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">pckg</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">packager</span><span class="hl-2">.</span><span class="hl-1">export</span><span class="hl-2">({ </span><span class="hl-6">packageLinkId:</span><span class="hl-2"> </span><span class="hl-6">myPackageId</span><span class="hl-2"> });</span><br/><span class="hl-0">// Save it manually for example JSON.stringify(pckg);</span><br/><span class="hl-0">// Import again in other system</span><br/><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">packager</span><span class="hl-2">.</span><span class="hl-1">import</span><span class="hl-2">(</span><span class="hl-6">pckg</span><span class="hl-2">);</span><br/><span class="hl-0">// Coming soon packager.update({ packageLinkId: myPackageId, pckg });</span>
</code><button type="button">Copy</button></pre>
<a id="md:write-and-read-packages-locally-for-example-on-server" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Write and read packages locally for example on server<a href="#md:write-and-read-packages-locally-for-example-on-server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="bash"><span class="hl-1">npx</span><span class="hl-2"> </span><span class="hl-4">@deep-foundation/deeplinks</span><span class="hl-2"> </span><span class="hl-3">--exec</span><span class="hl-2"> </span><span class="hl-3">--localhost</span>
</code><button type="button">Copy</button></pre>
<pre><code class="js"><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">packages</span><span class="hl-2"> = </span><span class="hl-6">deep</span><span class="hl-2">.</span><span class="hl-1">Packages</span><span class="hl-2">();</span><br/><span class="hl-0">// export and write</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">exported</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">packages</span><span class="hl-2">.</span><span class="hl-1">export</span><span class="hl-2">();</span><br/><span class="hl-0">// { [name@version]: Package } // possible Package.errors</span><br/><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">packages</span><span class="hl-2">.</span><span class="hl-1">write</span><span class="hl-2">(</span><span class="hl-6">process</span><span class="hl-2">.</span><span class="hl-1">cwd</span><span class="hl-2">(), </span><span class="hl-6">exported</span><span class="hl-2">);</span><br/><span class="hl-0">// read and import</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">readed</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">packages</span><span class="hl-2">.</span><span class="hl-1">read</span><span class="hl-2">(</span><span class="hl-6">process</span><span class="hl-2">.</span><span class="hl-1">cwd</span><span class="hl-2">());</span><br/><span class="hl-0">// { [name@version]: Package }</span><br/><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-7">imported</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">packages</span><span class="hl-2">.</span><span class="hl-1">import</span><span class="hl-2">(</span><span class="hl-6">readed</span><span class="hl-2">);</span><br/><span class="hl-0">// { [name@version]: Package } // possible Package.errors</span><br/><br/><span class="hl-0">// shorthand</span><br/><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">deep</span><span class="hl-2">.</span><span class="hl-1">Packages</span><span class="hl-2">().</span><span class="hl-1">write</span><span class="hl-2">(</span><span class="hl-6">process</span><span class="hl-2">.</span><span class="hl-1">cwd</span><span class="hl-2">(), </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">deep</span><span class="hl-2">.</span><span class="hl-1">Packages</span><span class="hl-2">().</span><span class="hl-1">export</span><span class="hl-2">());</span>
</code><button type="button">Copy</button></pre>
</div></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"><a href="#md:documentation"><span>Documentation</span></a><ul><li><a href="#md:container-and-cli"><span>Container and CLI</span></a></li><li><a href="#md:imports"><span>Imports</span></a></li><li><a href="#md:manual-exportimport-packages-from-admin-without-using-npm"><span>Manual export/import packages from admin, without using npm</span></a></li><li><a href="#md:write-and-read-packages-locally-for-example-on-server"><span>Write and read packages locally for example on server</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><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>