vusion-api
Version:
Vusion Node.js API
321 lines • 15.2 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>vusion-api</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">vusion-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>vusion-api</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#vusion-api" id="vusion-api" style="color: inherit; text-decoration: none;">
<h1>vusion-api</h1>
</a>
<ul>
<li><a href="README.zh-CN.md">中文说明</a></li>
</ul>
<p>A boilerplate for creating npm package repo.</p>
<p><a href="https://circleci.com/gh/vusion/vusion-api"><img src="https://img.shields.io/circleci/project/github/vusion/vusion-api.svg?style=flat-square" alt="CircleCI"></a>
<a href="http://npmjs.org/package/vusion-api"><img src="http://img.shields.io/npm/v/vusion-api.svg?style=flat-square" alt="NPM Version"></a>
<a href="https://david-dm.org/vusion/vusion-api"><img src="http://img.shields.io/david/vusion/vusion-api.svg?style=flat-square" alt="Dependencies"></a>
<a href="https://npmjs.org/package/vusion-api"><img src="https://img.shields.io/npm/dm/vusion-api.svg?style=flat-square" alt="NPM Download"></a></p>
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
<h2>Example</h2>
</a>
<p>Show an easy example can attract readers quickly.</p>
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
<h2>Features</h2>
</a>
<p>Introduce some major features of this project.</p>
<ul>
<li>Feature 1</li>
<li>Feature 2</li>
<li>Feature 3</li>
</ul>
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
<h2>Install</h2>
</a>
<pre><code class="language-shell">npm install --save vusion-api</code></pre>
<a href="#modules" id="modules" style="color: inherit; text-decoration: none;">
<h2>Modules</h2>
</a>
<a href="#fs" id="fs" style="color: inherit; text-decoration: none;">
<h3>fs</h3>
</a>
<p>文件系统</p>
<a href="#ms" id="ms" style="color: inherit; text-decoration: none;">
<h3>ms</h3>
</a>
<p>物料系统</p>
<a href="#config" id="config" style="color: inherit; text-decoration: none;">
<h3>config</h3>
</a>
<p>vusion.config.js 相关</p>
<a href="#rc" id="rc" style="color: inherit; text-decoration: none;">
<h3>rc</h3>
</a>
<p>.vusionrc 相关</p>
<a href="#develop" id="develop" style="color: inherit; text-decoration: none;">
<h2>Develop</h2>
</a>
<a href="#dev" id="dev" style="color: inherit; text-decoration: none;">
<h3>dev</h3>
</a>
<pre><code class="language-shell">npm run dev</code></pre>
<a href="#build" id="build" style="color: inherit; text-decoration: none;">
<h3>build</h3>
</a>
<pre><code class="language-shell">npm run build</code></pre>
<a href="#test" id="test" style="color: inherit; text-decoration: none;">
<h3>test</h3>
</a>
<pre><code class="language-shell">npm run test</code></pre>
<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
<h2>Changelog</h2>
</a>
<p>See <a href="https://github.com/vusion/vusion-api/releases">Releases</a></p>
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
<h2>Contributing</h2>
</a>
<p>See <a href="https://github.com/vusion/DOCUMENTATION/issues/8">Contributing Guide</a></p>
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
<h2>License</h2>
</a>
<p><a href="LICENSE">MIT</a></p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_cli_index_.html">"cli/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_cli_logger_.html">"cli/logger"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_cli_process_.html">"cli/process"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_config_getdefaults_.html">"config/get<wbr>Defaults"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_config_index_.html">"config/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_config_resolve_.html">"config/resolve"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_designer_index_.html">"designer/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_apihandler_.html">"fs/APIHandler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_directory_.html">"fs/<wbr>Directory"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_exampleshandler_.html">"fs/<wbr>Examples<wbr>Handler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_fsentry_.html">"fs/FSEntry"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_file_.html">"fs/<wbr>File"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_jsfile_.html">"fs/JSFile"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_library_.html">"fs/<wbr>Library"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_module_.html">"fs/<wbr>Module"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_page_.html">"fs/<wbr>Page"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_scripthandler_.html">"fs/<wbr>Script<wbr>Handler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_stylehandler_.html">"fs/<wbr>Style<wbr>Handler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_templatehandler_.html">"fs/<wbr>Template<wbr>Handler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_view_.html">"fs/<wbr>View"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_vuefile_.html">"fs/<wbr>Vue<wbr>File"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_index_.html">"fs/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fs_service_.html">"fs/service"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_ms_block_.html">"ms/<wbr>Block"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_ms_component_.html">"ms/<wbr>Component"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_ms_download_.html">"ms/download"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_ms_index_.html">"ms/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_rc_configurator_.html">"rc/configurator"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_rc_index_.html">"rc/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_types_packagejson_.html">"types/<wbr>PackageJSON"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_utils_index_.html">"utils/index"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>