vusion-api

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"fs/service" | 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> <li> <a href="_fs_service_.html">"fs/service"</a> </li> </ul> <h1>External module "fs/service"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_fs_service_.fileexistserror.html" class="tsd-kind-icon">File<wbr>Exists<wbr>Error</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_fs_service_.listfilesfilters.html" class="tsd-kind-icon">List<wbr>Files<wbr>Filters</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_fs_service_.html#replacer" class="tsd-kind-icon">Replacer</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#addapi" class="tsd-kind-icon">addAPI</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#adddocs" class="tsd-kind-icon">add<wbr>Docs</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#addmodulecss" class="tsd-kind-icon">add<wbr>ModuleCSS</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#addpackage" class="tsd-kind-icon">add<wbr>Package</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#batchreplace" class="tsd-kind-icon">batch<wbr>Replace</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#createdirectory" class="tsd-kind-icon">create<wbr>Directory</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#createmultifile" class="tsd-kind-icon">create<wbr>Multi<wbr>File</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#createmultifilepackage" class="tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>Package</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#createmultifilewithscreenshots" class="tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>With<wbr>Screenshots</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#createmultifilewithsubdocs" class="tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>With<wbr>Subdocs</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#createsinglefile" class="tsd-kind-icon">create<wbr>Single<wbr>File</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#deletefile" class="tsd-kind-icon">delete<wbr>File</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#extendtolibrary" class="tsd-kind-icon">extend<wbr>ToLibrary</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#extendtopath" class="tsd-kind-icon">extend<wbr>ToPath</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#handlesame" class="tsd-kind-icon">handle<wbr>Same</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#listallfiles" class="tsd-kind-icon">list<wbr>All<wbr>Files</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#listfiles" class="tsd-kind-icon">list<wbr>Files</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#movefiletotrash" class="tsd-kind-icon">move<wbr>File<wbr>ToTrash</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_fs_service_.html#rename" class="tsd-kind-icon">rename</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="replacer" class="tsd-anchor"></a> <h3>Replacer</h3> <div class="tsd-signature tsd-kind-icon">Replacer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L26">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:26</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="addapi" class="tsd-anchor"></a> <h3>addAPI</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">addAPI<span class="tsd-signature-symbol">(</span>vuePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L243">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:243</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>vuePath: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="adddocs" class="tsd-anchor"></a> <h3>add<wbr>Docs</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">add<wbr>Docs<span class="tsd-signature-symbol">(</span>vuePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L262">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:262</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>vuePath: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="addmodulecss" class="tsd-anchor"></a> <h3>add<wbr>ModuleCSS</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">add<wbr>ModuleCSS<span class="tsd-signature-symbol">(</span>vuePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L231">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:231</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>vuePath: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="addpackage" class="tsd-anchor"></a> <h3>add<wbr>Package</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">add<wbr>Package<span class="tsd-signature-symbol">(</span>vuePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L281">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:281</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>vuePath: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="batchreplace" class="tsd-anchor"></a> <h3>batch<wbr>Replace</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">batch<wbr>Replace<span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span>, replacers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="_fs_service_.html#replacer" class="tsd-signature-type">Replacer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L27">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:27</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>src: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5> </li> <li> <h5>replacers: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="_fs_service_.html#replacer" class="tsd-signature-type">Replacer</a><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="createdirectory" class="tsd-anchor"></a> <h3>create<wbr>Directory</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">create<wbr>Directory<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dirName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L100">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:100</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>dirName: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="createmultifile" class="tsd-anchor"></a> <h3>create<wbr>Multi<wbr>File</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">create<wbr>Multi<wbr>File<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, componentName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L152">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:152</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> componentName: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="createmultifilepackage" class="tsd-anchor"></a> <h3>create<wbr>Multi<wbr>File<wbr>Package</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>Package<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, componentName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L213">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:213</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> componentName: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="createmultifilewithscreenshots" class="tsd-anchor"></a> <h3>create<wbr>Multi<wbr>File<wbr>With<wbr>Screenshots</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>With<wbr>Screenshots<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, componentName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L193">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:193</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> componentName: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="createmultifilewithsubdocs" class="tsd-anchor"></a> <h3>create<wbr>Multi<wbr>File<wbr>With<wbr>Subdocs</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>With<wbr>Subdocs<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, componentName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L172">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:172</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> componentName: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="createsinglefile" class="tsd-anchor"></a> <h3>create<wbr>Single<wbr>File</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">create<wbr>Single<wbr>File<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, componentName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L138">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:138</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> componentName: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="deletefile" class="tsd-anchor"></a> <h3>delete<wbr>File</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">delete<wbr>File<span class="tsd-signature-symbol">(</span>fullPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L121">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:121</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fullPath: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="extendtolibrary" class="tsd-anchor"></a> <h3>extend<wbr>ToLibrary</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">extend<wbr>ToLibrary<span class="tsd-signature-symbol">(</span>vueFile<span class="tsd-signature-symbol">: </span><a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a>, from<span class="tsd-signature-symbol">: </span><a href="../classes/_fs_library_.library.html" class="tsd-signature-type">Library</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, to<span class="tsd-signature-symbol">: </span><a href="../classes/_fs_library_.library.html" class="tsd-signature-type">Library</a>, mode<span class="tsd-signature-symbol">: </span><a href="../enums/_fs_vuefile_.vuefileextendmode.html" class="tsd-signature-type">VueFileExtendMode</a>, subDir<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L334">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:334</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>扩展到新的库中</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>vueFile: <a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a></h5> <div class="tsd-comment tsd-typography"> <p>原组件库需要扩展的组件，一级、二级组件均可</p> </div> </li> <li> <h5>from: <a href="../classes/_fs_library_.library.html" class="tsd-signature-type">Library</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>原来的库，或者 VueFile 本身的路径</p> </div> </li> <li> <h5>to: <a href="../classes/_fs_library_.library.html" class="tsd-signature-type">Library</a></h5> <div class="tsd-comment tsd-typography"> <p>需要扩展到的组件库，比如 internalLibrary</p> </div> </li> <li> <h5>mode: <a href="../enums/_fs_vuefile_.vuefileextendmode.html" class="tsd-signature-type">VueFileExtendMode</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> subDir: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="extendtopath" class="tsd-anchor"></a> <h3>extend<wbr>ToPath</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">extend<wbr>ToPath<span class="tsd-signature-symbol">(</span>vueFile<span class="tsd-signature-symbol">: </span><a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a>, from<span class="tsd-signature-symbol">: </span><a href="../classes/_fs_library_.library.html" class="tsd-signature-type">Library</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mode<span class="tsd-signature-symbol">: </span><a href="../enums/_fs_vuefile_.vuefileextendmode.html" class="tsd-signature-type">VueFileExtendMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L306">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:306</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>扩展到新的路径中</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>vueFile: <a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a></h5> <div class="tsd-comment tsd-typography"> <p>原组件库需要扩展的组件，一级、二级组件均可</p> </div> </li> <li> <h5>from: <a href="../classes/_fs_library_.library.html" class="tsd-signature-type">Library</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>原来的库，或者 VueFile 本身的路径</p> </div> </li> <li> <h5>to: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>新的路径</p> </div> </li> <li> <h5>mode: <a href="../enums/_fs_vuefile_.vuefileextendmode.html" class="tsd-signature-type">VueFileExtendMode</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_fs_vuefile_.vuefile.html" class="tsd-signature-type">VueFile</a><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="handlesame" class="tsd-anchor"></a> <h3>handle<wbr>Same</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">handle<wbr>Same<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, baseName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L17">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:17</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> baseName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "u-sample"</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="listallfiles" class="tsd-anchor"></a> <h3>list<wbr>All<wbr>Files</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">list<wbr>All<wbr>Files<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, filters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_fs_service_.listfilesfilters.html" class="tsd-signature-type">ListFilesFilters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L94">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:94</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> dir: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> filters: <a href="../interfaces/_fs_service_.listfilesfilters.html" class="tsd-signature-type">ListFilesFilters</a><span class="tsd-signature-symbol"> = {}</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="listfiles" class="tsd-anchor"></a> <h3>list<wbr>Files</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">list<wbr>Files<span class="tsd-signature-symbol">(</span>dir<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, filters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_fs_service_.listfilesfilters.html" class="tsd-signature-type">ListFilesFilters</a>, recursive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L47">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:47</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> dir: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> filters: <a href="../interfaces/_fs_service_.listfilesfilters.html" class="tsd-signature-type">ListFilesFilters</a><span class="tsd-signature-symbol"> = {}</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> recursive: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="movefiletotrash" class="tsd-anchor"></a> <h3>move<wbr>File<wbr>ToTrash</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">move<wbr>File<wbr>ToTrash<span class="tsd-signature-symbol">(</span>fullPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L109">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:109</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fullPath: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="rename" class="tsd-anchor"></a> <h3>rename</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">rename<span class="tsd-signature-symbol">(</span>fullPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, newName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/vusion/vusion-api/blob/786d246/src/fs/service.ts#L126">Projects/GitHub/VusionIDE/vusion-api/src/fs/service.ts:126</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fullPath: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>newName: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> </section> </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="current tsd-kind-external-module"> <a href="_fs_service_.html">"fs/service"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="../classes/_fs_service_.fileexistserror.html" class="tsd-kind-icon">File<wbr>Exists<wbr>Error</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_fs_service_.listfilesfilters.html" class="tsd-kind-icon">List<wbr>Files<wbr>Filters</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_fs_service_.html#replacer" class="tsd-kind-icon">Replacer</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#addapi" class="tsd-kind-icon">addAPI</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#adddocs" class="tsd-kind-icon">add<wbr>Docs</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#addmodulecss" class="tsd-kind-icon">add<wbr>ModuleCSS</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#addpackage" class="tsd-kind-icon">add<wbr>Package</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#batchreplace" class="tsd-kind-icon">batch<wbr>Replace</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#createdirectory" class="tsd-kind-icon">create<wbr>Directory</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#createmultifile" class="tsd-kind-icon">create<wbr>Multi<wbr>File</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#createmultifilepackage" class="tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>Package</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#createmultifilewithscreenshots" class="tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>With<wbr>Screenshots</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#createmultifilewithsubdocs" class="tsd-kind-icon">create<wbr>Multi<wbr>File<wbr>With<wbr>Subdocs</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#createsinglefile" class="tsd-kind-icon">create<wbr>Single<wbr>File</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#deletefile" class="tsd-kind-icon">delete<wbr>File</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#extendtolibrary" class="tsd-kind-icon">extend<wbr>ToLibrary</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#extendtopath" class="tsd-kind-icon">extend<wbr>ToPath</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#handlesame" class="tsd-kind-icon">handle<wbr>Same</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#listallfiles" class="tsd-kind-icon">list<wbr>All<wbr>Files</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#listfiles" class="tsd-kind-icon">list<wbr>Files</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#movefiletotrash" class="tsd-kind-icon">move<wbr>File<wbr>ToTrash</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_fs_service_.html#rename" class="tsd-kind-icon">rename</a> </li> </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="