jsdk-offical

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Files | JSDK 2.7.0 API</title> <meta name="description" content="Documentation for JSDK 2.7.0 API"> <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.json" 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">JSDK 2.7.0 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="../modules/js.html">JS</a> </li> <li> <a href="../modules/js.util.html">util</a> </li> <li> <a href="js.util.files.html">Files</a> </li> </ul> <h1>Class Files</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>File Helper</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Files</span> </li> </ul> </section> <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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#one_gb" class="tsd-kind-icon">ONE_<wbr>GB</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#one_kb" class="tsd-kind-icon">ONE_<wbr>KB</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#one_mb" class="tsd-kind-icon">ONE_<wbr>MB</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#one_tb" class="tsd-kind-icon">ONE_<wbr>TB</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#convertsize" class="tsd-kind-icon">convert<wbr>Size</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#getfilename" class="tsd-kind-icon">get<wbr>File<wbr>Name</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#getfiletype" class="tsd-kind-icon">get<wbr>File<wbr>Type</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#isfiletype" class="tsd-kind-icon">is<wbr>File<wbr>Type</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="js.util.files.html#tosizestring" class="tsd-kind-icon">to<wbr>Size<wbr>String</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="one_gb" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> ONE_<wbr>GB</h3> <div class="tsd-signature tsd-kind-icon">ONE_<wbr>GB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1073741824</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="one_kb" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> ONE_<wbr>KB</h3> <div class="tsd-signature tsd-kind-icon">ONE_<wbr>KB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1024</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="one_mb" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> ONE_<wbr>MB</h3> <div class="tsd-signature tsd-kind-icon">ONE_<wbr>MB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1048576</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="one_tb" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> ONE_<wbr>TB</h3> <div class="tsd-signature tsd-kind-icon">ONE_<wbr>TB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1099511627776</span></div> <aside class="tsd-sources"> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="convertsize" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> convert<wbr>Size</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">convert<wbr>Size<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, orgUnit<span class="tsd-signature-symbol">: </span><a href="../enums/js.util.filesizeunit.html" class="tsd-signature-type">FileSizeUnit</a>, tarUnit<span class="tsd-signature-symbol">: </span><a href="../enums/js.util.filesizeunit.html" class="tsd-signature-type">FileSizeUnit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>size: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5> </li> <li> <h5>orgUnit: <a href="../enums/js.util.filesizeunit.html" class="tsd-signature-type">FileSizeUnit</a></h5> </li> <li> <h5>tarUnit: <a href="../enums/js.util.filesizeunit.html" class="tsd-signature-type">FileSizeUnit</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="getfilename" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>File<wbr>Name</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Name<span class="tsd-signature-symbol">(</span>path<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"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</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-method tsd-parent-kind-class tsd-is-static"> <a name="getfiletype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>File<wbr>Type</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Type<span class="tsd-signature-symbol">(</span>path<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"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</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-method tsd-parent-kind-class tsd-is-static"> <a name="isfiletype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>File<wbr>Type</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">is<wbr>File<wbr>Type<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, exts<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">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>exts: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="tosizestring" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> to<wbr>Size<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">to<wbr>Size<wbr>String<span class="tsd-signature-symbol">(</span>byte<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, sizeUnit<span class="tsd-signature-symbol">?: </span><a href="../enums/js.util.filesizeunit.html" class="tsd-signature-type">FileSizeUnit</a><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"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>byte: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> sizeUnit: <a href="../enums/js.util.filesizeunit.html" class="tsd-signature-type">FileSizeUnit</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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-namespace"> <a href="../modules/js.html">JS</a> <ul> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.an.html">an</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.app.html">app</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.core.html">core</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.d2.html">d2</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ds.html">ds</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.fx.html">fx</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.input.html">input</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ioc.html">ioc</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.lang.html">lang</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.math.html">math</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.media.html">media</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.model.html">model</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.net.html">net</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.store.html">store</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.sugar.html">sugar</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ui.html">ui</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.unit.html">unit</a> </li> <li class="current tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.util.html">util</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.view.html">view</a> </li> </ul> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-namespace"> <a href="js.util.files.html" class="tsd-kind-icon">Files</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#one_gb" class="tsd-kind-icon">ONE_<wbr>GB</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#one_kb" class="tsd-kind-icon">ONE_<wbr>KB</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#one_mb" class="tsd-kind-icon">ONE_<wbr>MB</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#one_tb" class="tsd-kind-icon">ONE_<wbr>TB</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#convertsize" class="tsd-kind-icon">convert<wbr>Size</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#getfilename" class="tsd-kind-icon">get<wbr>File<wbr>Name</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#getfiletype" class="tsd-kind-icon">get<wbr>File<wbr>Type</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#isfiletype" class="tsd-kind-icon">is<wbr>File<wbr>Type</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="js.util.files.html#tosizestring" class="tsd-kind-icon">to<wbr>Size<wbr>String</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <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> </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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <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>