<!--

Documentation generated by Skydoc

-->

<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8">

<meta name="viewport" content="width=device-width initial-scale=1" />

<meta http-equiv="X-UA-Compatible" content="IE=edge">

<title>Run http-server</title>

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,600,700" type="text/css">

<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">

<link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css">

<script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script>

<link rel="stylesheet" href="/rules_nodejs/main.css">

</head>

<body>

<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer

mdl-layout--fixed-header">

<header class="mdl-layout__header">

<div class="mdl-layout__header-row">

<span class="mdl-layout-title">Run http-server</span>

</div>

</header>

<div class="mdl-layout__drawer">

<span class="mdl-layout-title">Bazel</span>

<nav class="drawer-nav">

<ul class="drawer-nav">

<li><a href="/rules_nodejs/index.html">Overview</a></li>

<li>

<a href="/rules_nodejs/common/check_bazel_version.html">Check Bazel version</a>

<ul>

<li><a href="/rules_nodejs/common/check_bazel_version.html#overview">Overview</a></li>

</ul>

</li>

<li>

<a href="/rules_nodejs/history-server/history_server.html">Run history-server</a>

<ul>

</ul>

</li>

<li>

<a href="/rules_nodejs/http-server/http_server.html">Run http-server</a>

<ul>

</ul>

</li>

<li>

<a href="/rules_nodejs/jasmine_node_test/jasmine_node_test.html">NodeJS testing</a>

<ul>

<li><a href="/rules_nodejs/jasmine_node_test/jasmine_node_test.html#overview">Overview</a></li>

</ul>

</li>

<li>

<a href="/rules_nodejs/node/node.html">Executing programs</a>

<ul>

<li><a href="/rules_nodejs/node/node.html#overview">Overview</a></li>

<li>

<a href="/rules_nodejs/node/node.html#nodejs_binary">

nodejs_binary

</a>

</li>

<li>

<a href="/rules_nodejs/node/node.html#nodejs_test">

nodejs_test

</a>

</li>

</ul>

</li>

<li>

<a href="/rules_nodejs/node/node_repositories.html">Install NodeJS & Yarn</a>

<ul>

<li><a href="/rules_nodejs/node/node_repositories.html#overview">Overview</a></li>

</ul>

</li>

<li>

<a href="/rules_nodejs/npm_install/npm_install.html">Install npm packages</a>

<ul>

<li><a href="/rules_nodejs/npm_install/npm_install.html#overview">Overview</a></li>

</ul>

</li>

<li>

<a href="/rules_nodejs/npm_package/npm_package.html">npm packaging</a>

<ul>

<li><a href="/rules_nodejs/npm_package/npm_package.html#overview">Overview</a></li>

<li>

<a href="/rules_nodejs/npm_package/npm_package.html#npm_package">

npm_package

</a>

</li>

</ul>

</li>

<li>

<a href="/rules_nodejs/rollup/rollup_bundle.html">Rollup bundling</a>

<ul>

<li><a href="/rules_nodejs/rollup/rollup_bundle.html#overview">Overview</a></li>

<li>

<a href="/rules_nodejs/rollup/rollup_bundle.html#rollup_bundle">

rollup_bundle

</a>

</li>

</ul>

</li>

</ul>

</nav>

</div>

<main class="mdl-layout__content">

<div class="page-content">

<h1>Run http-server</h1>

<nav class="toc">

<h2>Macros</h2>

<ul>

<li><a href="#http_server">http_server</a></li>

</ul>

</nav>

<hr>

<h2 id="http_server">http_server</h2>

<pre>http_server(<a href="#http_server.templated_args">templated_args</a>, <a href="#http_server.**kwargs">**kwargs</a>)</pre>

<p>This is a simple Bazel wrapper around the http-server npm package.</p>

<p>See <a href="https://www.npmjs.com/package/http-server">https://www.npmjs.com/package/http-server</a></p>

<p>A typical frontend project is served by a specific server.

For typical example applications, our needs are simple so we can just use http-server.

Real projects might need history-server (for router support) or even better a full-featured production server like express.</p>

<p>This rule uses a modified http-server to support serving Brotli-compressed files, which end with a .br extension.

This is equivalent to gzip-compression support.

See <a href="https://github.com/alexeagle/http-server/commits/master">https://github.com/alexeagle/http-server/commits/master</a> which points to a modified ecstatic library.</p>

<h3 id="http_server_args">Attributes</h3>

<table class="params-table">

<colgroup>

<col class="col-param" />

<col class="col-description" />

</colgroup>

<tbody>

<tr id="http_server.templated_args">

<td><code>templated_args</code></td>

<td>

<p><code>List of strings; Optional</code></p>

<p>arguments to pass to every invocation of the binary</p>

</td>

</tr>

<tr id="http_server.**kwargs">

<td><code>**kwargs</code></td>

<td>

<p><code>Unknown; Optional</code></p>

<p>passed through to the underlying nodejs_binary</p>

</td>

</tr>

</tbody>

</table>

</div>

<footer class="mdl-mini-footer">

<div class="mdl-mini-footer__left-section">

<div class="mdl-logo">Bazel</div>

<ul class="mdl-mini-footer__link-list">

<li><a href="https://bazel.build">Home</a></li>

<li><a href="https://github.com/bazelbuild">GitHub</a></li>

</ul>

</div>

</footer>

</main>

</div>

</body>

</html>