<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/src/rust_wasm_bindgen_rules_nodejs.md - fork/rules_rust @ cleanup</title>
<meta name="description" content="docs/src/rust_wasm_bindgen_rules_nodejs.md in fork/rules_rust at cleanup.">
<meta property="og:title" content="docs/src/rust_wasm_bindgen_rules_nodejs.md - fork/rules_rust @ cleanup">
<meta property="og:description" content="docs/src/rust_wasm_bindgen_rules_nodejs.md in fork/rules_rust at cleanup.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="cleanup" data-tip="a4c87621ebc87a3e20fc4a1cdb273945ddb5ac86">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">UebelAndre</span><span class="commit-message" data-commit="2bad96d928961003e3bc8822e9054424a84d2493">Moved rust extension rules into a separate `rules_rust_ext` workspace. (#3007)</span><span class="snapshot-sha sha" data-commit="2bad96d928961003e3bc8822e9054424a84d2493">2bad96d9</span><time datetime="2024-11-26T11:38:21-08:00" title="2024-11-26 11:38:21 -0800">2024-11-26</time></p>
<header class="topbar"><details class="switcher"><summary>cleanup</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/cleanup/tree/docs/">docs</a> / <a href="/fork/rules_rust/ref/cleanup/tree/docs/src/">src</a> / <span class="cur">rust_wasm_bindgen_rules_nodejs.md</span></nav>
<span class="view-stats"><span>1.9 KiB</span><span>29 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/d27ca15e553faa1eb5cb7e796eabc486d5a7ad78/docs/src/rust_wasm_bindgen_rules_nodejs.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;
<p>Rust WASM-bindgen rules for interfacing with bazelbuild/rules_nodejs</p>
<p>&lt;a id="nodejs_rust_wasm_bindgen"&gt;&lt;/a&gt;</p>
<h2>nodejs_rust_wasm_bindgen</h2>
&lt;pre&gt;
nodejs_rust_wasm_bindgen(&lt;a href="#nodejs_rust_wasm_bindgen-name"&gt;name&lt;/a&gt;, &lt;a href="#nodejs_rust_wasm_bindgen-bindgen_flags"&gt;bindgen_flags&lt;/a&gt;, &lt;a href="#nodejs_rust_wasm_bindgen-target"&gt;target&lt;/a&gt;, &lt;a href="#nodejs_rust_wasm_bindgen-target_arch"&gt;target_arch&lt;/a&gt;, &lt;a href="#nodejs_rust_wasm_bindgen-wasm_file"&gt;wasm_file&lt;/a&gt;)
&lt;/pre&gt;
<p>Generates javascript and typescript bindings for a webassembly module using <a href="https://rustwasm.github.io/docs/wasm-bindgen/">wasm-bindgen</a> that interface with <a href="https://github.com/bazelbuild/rules_nodejs">bazelbuild/rules_nodejs</a>.</p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="nodejs_rust_wasm_bindgen-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="nodejs_rust_wasm_bindgen-bindgen_flags"&gt;&lt;/a&gt;bindgen_flags</td><td style="text-align: left">Flags to pass directly to the bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details.</td><td style="text-align: left">List of strings</td><td style="text-align: left">optional</td><td style="text-align: left"><code>[]</code></td></tr>
<tr><td style="text-align: left">&lt;a id="nodejs_rust_wasm_bindgen-target"&gt;&lt;/a&gt;target</td><td style="text-align: left">The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"bundler"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="nodejs_rust_wasm_bindgen-target_arch"&gt;&lt;/a&gt;target_arch</td><td style="text-align: left">The target architecture to use for the wasm-bindgen command line option.</td><td style="text-align: left">String</td><td style="text-align: left">optional</td><td style="text-align: left"><code>"wasm32"</code></td></tr>
<tr><td style="text-align: left">&lt;a id="nodejs_rust_wasm_bindgen-wasm_file"&gt;&lt;/a&gt;wasm_file</td><td style="text-align: left">The <code>.wasm</code> file or crate to generate bindings for.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
</tbody></table>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">Rust WASM-bindgen rules for interfacing with bazelbuild/rules_nodejs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">&lt;a id=&quot;nodejs_rust_wasm_bindgen&quot;&gt;&lt;/a&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>##</a-p> <a-tt>nodejs_rust_wasm_bindgen</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>nodejs_rust_wasm_bindgen(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#nodejs_rust_wasm_bindgen-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#nodejs_rust_wasm_bindgen-bindgen_flags</a-s><a-p>&quot;&gt;bindgen_flags&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#nodejs_rust_wasm_bindgen-target</a-s><a-p>&quot;&gt;target&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#nodejs_rust_wasm_bindgen-target_arch</a-s><a-p>&quot;&gt;target_arch&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#nodejs_rust_wasm_bindgen-wasm_file</a-s><a-p>&quot;&gt;wasm_file&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>Generates javascript and typescript bindings for a webassembly module using [wasm-bindgen][ws] that interface with [bazelbuild/rules_nodejs][bbnjs].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-tu>[ws]</a-tu><a-p>: </a-p><a-tu>https://rustwasm.github.io/docs/wasm-bindgen/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-tu>[bbnjs]</a-tu><a-p>: </a-p><a-tu>https://github.com/bazelbuild/rules_nodejs</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">**ATTRIBUTES**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">| Name  | Description | Type | Mandatory | Default |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">| :------------- | :------------- | :------------- | :------------- | :------------- |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">| &lt;a id=&quot;nodejs_rust_wasm_bindgen-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">| &lt;a id=&quot;nodejs_rust_wasm_bindgen-bindgen_flags&quot;&gt;&lt;/a&gt;bindgen_flags |  Flags to pass directly to the bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details.   | List of strings | optional |  `[]`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">| &lt;a id=&quot;nodejs_rust_wasm_bindgen-target&quot;&gt;&lt;/a&gt;target |  The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details.   | String | optional |  `&quot;bundler&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">| &lt;a id=&quot;nodejs_rust_wasm_bindgen-target_arch&quot;&gt;&lt;/a&gt;target_arch |  The target architecture to use for the wasm-bindgen command line option.   | String | optional |  `&quot;wasm32&quot;`  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">| &lt;a id=&quot;nodejs_rust_wasm_bindgen-wasm_file&quot;&gt;&lt;/a&gt;wasm_file |  The `.wasm` file or crate to generate bindings for.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
