Files
welshman/docs/modules/_welshman_dvm.html
T
2024-12-13 14:16:38 -08:00

9 lines
25 KiB
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>@welshman/dvm | Welshman Docs</title><meta name="description" content="Documentation for Welshman Docs"/><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"><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">Welshman Docs</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">Welshman Docs</a></li><li><a href="_welshman_dvm.html">@welshman/dvm</a></li></ul><h1>Module @welshman/dvm</h1></div><section class="tsd-panel tsd-typography"><a id="welshmandvm-version" class="tsd-anchor"></a><h1 class="tsd-anchor-link">@welshman/dvm <a href="https://npmjs.com/package/@welshman/dvm" target="_blank" class="external"><img src="https://badgen.net/npm/v/@welshman/dvm" alt="version"></a><a href="#welshmandvm-version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Utilities for building nostr DVMs.</p>
<a id="request-example" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Request example<a href="#request-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><pre><code class="javascript"><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-0">type</span><span class="hl-1"> {</span><span class="hl-2">Publish</span><span class="hl-1">, </span><span class="hl-2">Subscription</span><span class="hl-1">} </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@welshman/net&#39;</span><br/><span class="hl-0">import</span><span class="hl-1"> {</span><span class="hl-2">makeDvmRequest</span><span class="hl-1">, </span><span class="hl-2">DVMEvent</span><span class="hl-1">} </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@welshman/dvm&#39;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">req</span><span class="hl-1"> = </span><span class="hl-5">makeDvmRequest</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">// Create and sign a dvm request event, including any desired tags</span><br/><span class="hl-1"> </span><span class="hl-2">event:</span><span class="hl-1"> </span><span class="hl-5">createAndSign</span><span class="hl-1">({</span><span class="hl-2">kind:</span><span class="hl-1"> </span><span class="hl-8">5300</span><span class="hl-1">}),</span><br/><span class="hl-1"> </span><span class="hl-4">// Publish and subscribe to these relays</span><br/><span class="hl-1"> </span><span class="hl-2">relays:</span><span class="hl-1"> [</span><span class="hl-3">&#39;wss://relay.damus.io&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;wss://dvms.f7z.io&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-4">// Timeout defaults to 30 seconds</span><br/><span class="hl-1"> </span><span class="hl-2">timeout:</span><span class="hl-1"> </span><span class="hl-8">30_000</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">// Auto close on first result (defaults to true)</span><br/><span class="hl-1"> </span><span class="hl-2">autoClose:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">// Listen for and emit `progress` events</span><br/><span class="hl-1"> </span><span class="hl-2">reportProgress:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-4">// Listen for progress, result, etc</span><br/><span class="hl-2">req</span><span class="hl-1">.</span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-2">DVMEvent</span><span class="hl-1">.</span><span class="hl-2">Progress</span><span class="hl-1">, (</span><span class="hl-2">url</span><span class="hl-1">, </span><span class="hl-2">event</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-2">event</span><span class="hl-1">))</span><br/><span class="hl-2">req</span><span class="hl-1">.</span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-2">DVMEvent</span><span class="hl-1">.</span><span class="hl-2">Result</span><span class="hl-1">, (</span><span class="hl-2">url</span><span class="hl-1">, </span><span class="hl-2">event</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-2">event</span><span class="hl-1">))</span>
</code><button type="button">Copy</button></pre>
<a id="handler-example" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Handler example<a href="#handler-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><pre><code class="javascript"><span class="hl-6">const</span><span class="hl-1"> {</span><span class="hl-7">bytesToHex</span><span class="hl-1">} = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-3">&#39;@noble/hashes/utils&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">const</span><span class="hl-1"> {</span><span class="hl-7">generateSecretKey</span><span class="hl-1">} = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-3">&#39;nostr-tools&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">const</span><span class="hl-1"> {</span><span class="hl-7">createEvent</span><span class="hl-1">} = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-3">&#39;@welshman/util&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">const</span><span class="hl-1"> {</span><span class="hl-7">subscribe</span><span class="hl-1">} = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-3">&#39;@welshman/net&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">const</span><span class="hl-1"> {</span><span class="hl-7">DVM</span><span class="hl-1">} = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-3">&#39;@welshman/dvm&#39;</span><span class="hl-1">)</span><br/><br/><span class="hl-4">// Your DVM&#39;s private key. Store this somewhere safe</span><br/><span class="hl-4">// const hexPrivateKey = bytesToHex(generateSecretKey())</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">hexPrivateKey</span><span class="hl-1"> = </span><span class="hl-3">&#39;9cd387a3aa0c1abc2ef517c8402f29c069b4174e02a426491aec7566501bee67&#39;</span><br/><br/><span class="hl-4">// Tags that we&#39;ll return as content discovery suggestions</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">tags</span><span class="hl-1"> = []</span><br/><br/><span class="hl-4">// Populate the tags with music by Ainsley Costello</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">sub</span><span class="hl-1"> = </span><span class="hl-5">subscribe</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">timeout:</span><span class="hl-1"> </span><span class="hl-8">30_000</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">relays:</span><span class="hl-1"> [</span><span class="hl-3">&quot;wss://relay.wavlake.com&quot;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-2">filters:</span><span class="hl-1"> [{</span><br/><span class="hl-1"> </span><span class="hl-2">kinds:</span><span class="hl-1"> [</span><span class="hl-8">31337</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-3">&#39;#p&#39;</span><span class="hl-2">:</span><span class="hl-1"> [</span><span class="hl-3">&#39;8806372af51515bf4aef807291b96487ea1826c966a5596bca86697b5d8b23bc&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> }],</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-4">// Push event ids to our suggestions</span><br/><span class="hl-2">sub</span><span class="hl-1">.</span><span class="hl-2">emitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-3">&#39;event&#39;</span><span class="hl-1">, (</span><span class="hl-2">url</span><span class="hl-1">, </span><span class="hl-2">e</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-2">tags</span><span class="hl-1">.</span><span class="hl-5">push</span><span class="hl-1">([</span><span class="hl-3">&quot;e&quot;</span><span class="hl-1">, </span><span class="hl-2">e</span><span class="hl-1">.</span><span class="hl-2">id</span><span class="hl-1">, </span><span class="hl-2">url</span><span class="hl-1">]))</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">dvm</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-5">DVM</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">// The private key used to sign events</span><br/><span class="hl-1"> </span><span class="hl-2">sk:</span><span class="hl-1"> </span><span class="hl-2">hexPrivateKey</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">// Relays that the DVM will listen on</span><br/><span class="hl-1"> </span><span class="hl-2">relays:</span><span class="hl-1"> [</span><span class="hl-3">&#39;wss://relay.damus.io&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;wss://dvms.f7z.io&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-4">// Only listen to requests tagging our dvm</span><br/><span class="hl-1"> </span><span class="hl-2">requireMention:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">// Expire results after 1 hour (the default)</span><br/><span class="hl-1"> </span><span class="hl-2">expireAfter:</span><span class="hl-1"> </span><span class="hl-8">60</span><span class="hl-1"> * </span><span class="hl-8">60</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">// Handlers for various kinds</span><br/><span class="hl-1"> </span><span class="hl-2">handlers:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">5300</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-2">dvm</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> ({</span><br/><span class="hl-1"> </span><span class="hl-5">handleEvent</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-6">async</span><span class="hl-1"> </span><span class="hl-6">function*</span><span class="hl-1"> (</span><span class="hl-2">event</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">// DVM responses are stringified into the content</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">content</span><span class="hl-1"> = </span><span class="hl-7">JSON</span><span class="hl-1">.</span><span class="hl-5">stringify</span><span class="hl-1">(</span><span class="hl-2">tags</span><span class="hl-1">)</span><br/><br/><span class="hl-1"> </span><span class="hl-4">// Yield our response. Kind 7000 can be used for partial results too</span><br/><span class="hl-1"> </span><span class="hl-0">yield</span><span class="hl-1"> </span><span class="hl-5">createEvent</span><span class="hl-1">(</span><span class="hl-2">event</span><span class="hl-1">.</span><span class="hl-2">kind</span><span class="hl-1"> + </span><span class="hl-8">1000</span><span class="hl-1">, {</span><span class="hl-2">content</span><span class="hl-1">})</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> }),</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-4">// Enable logging</span><br/><span class="hl-2">dvm</span><span class="hl-1">.</span><span class="hl-2">logEvents</span><span class="hl-1"> = </span><span class="hl-6">true</span><br/><br/><span class="hl-4">// When you&#39;re ready</span><br/><span class="hl-2">dvm</span><span class="hl-1">.</span><span class="hl-5">start</span><span class="hl-1">()</span><br/><br/><span class="hl-4">// When you&#39;re done</span><br/><span class="hl-2">dvm</span><span class="hl-1">.</span><span class="hl-5">stop</span><span class="hl-1">()</span>
</code><button type="button">Copy</button></pre>
</section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumerations"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumerations</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="dvmevent" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_welshman_dvm.DVMEvent.html">DVMEvent</a><a href="#dvmevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="dvm" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_welshman_dvm.DVM.html">DVM</a><a href="#dvm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Type Aliases"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Type Aliases</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="createdvmhandler" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><a href="../types/_welshman_dvm.CreateDVMHandler.html">CreateDVMHandler</a><a href="#createdvmhandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="dvmhandler" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><a href="../types/_welshman_dvm.DVMHandler.html">DVMHandler</a><a href="#dvmhandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="dvmopts" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><a href="../types/_welshman_dvm.DVMOpts.html">DVMOpts</a><a href="#dvmopts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="dvmrequest" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><a href="../types/_welshman_dvm.DVMRequest.html">DVMRequest</a><a href="#dvmrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="dvmrequestoptions" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><a href="../types/_welshman_dvm.DVMRequestOptions.html">DVMRequestOptions</a><a href="#dvmrequestoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="makedvmrequest" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_welshman_dvm.makeDvmRequest.html">makeDvmRequest</a><a href="#makedvmrequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></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"><a href="#welshmandvm-version"><span>@welshman/dvm version</span></a><a href="#request-example"><span>Request example</span></a><a href="#handler-example"><span>Handler example</span></a><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumerations"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumerations</summary><div><a href="#dvmevent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>DVMEvent</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#dvm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>DVM</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Type Aliases"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Type Aliases</summary><div><a href="#createdvmhandler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>CreateDVMHandler</span></a><a href="#dvmhandler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>DVMHandler</span></a><a href="#dvmopts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>DVMOpts</span></a><a href="#dvmrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>DVMRequest</span></a><a href="#dvmrequestoptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>DVMRequest<wbr/>Options</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#makedvmrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>make<wbr/>Dvm<wbr/>Request</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Welshman Docs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>