documon
Version:
A documentation system for mortals. Use with any language.
804 lines (389 loc) • 22.4 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>fileutils</title>
<meta name="description" content="Basic, common and simplified asyncronous file methods.">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "documon.fileutils",
name: "fileutils"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="main-method">
<a name="methods"></a>
<div class="part-methods">
<a name="documon.fileutils"></a><a name="fileutils"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
fileutils ()
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">13</span>
</span>
</div>
<div class="member-description">
<div class="meta-block meta-block-klass">
<div class="meta-line"><span class="meta-label" >xpath</span> <span class="meta-target">documon.fileutils<span></div>
<div class="meta-line"><span class="meta-label" >file</span> <span class="meta-target">documon/src/fileutils.js<span></div>
</div>
<p>Basic, common and simplified asyncronous file methods.</p>
</div>
</div>
</div>
</div>
<div class="parts">
<a name="methods"></a>
<div class="part-methods">
<div class="heading-part">Methods</div>
<a name="documon.fileutils.copy"></a><a name="copy"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
copy (<span class="method-arguments">src</span>, <span class="method-arguments">dest</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">24</span>
</span>
</div>
<div class="member-description">
<p>Copies a file from one location to another.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">src</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The source file path.</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">dest</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The destination to copy the source to.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a name="documon.fileutils.exists"></a><a name="exists"></a>
<div class="member" data-access="private" >
<div class="member-name clearfix">
<span class="member-name-left">
exists (<span class="method-arguments">src</span>)
<span class="flag private">private</span> <!-- public private protected -->
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">96</span>
</span>
</div>
<div class="member-description">
<p>Cehcsk to see if a file exists. Note this also checks if a folder of the same name exists too.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">src</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">type</span>
<div class="member-description">
<p>The source file path.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="heading-returns">Returns
<span class="type">boolean</span>
</div>
<div class="member"><p>True if exists, false if no file nor folder exists.</p></div>
</div>
</div>
<a name="documon.fileutils.Open"></a><a name="Open"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
Open (<span class="method-arguments">src</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">45</span>
</span>
</div>
<div class="member-description">
<p>Reads the entire file as a string. NOTE: This is an alias for <a href="#read">read</a>.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">src</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The source file path.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="heading-returns">Returns
<span class="type">string</span>
</div>
<div class="member"><p>description description</p></div>
</div>
</div>
<a name="documon.fileutils.read"></a><a name="read"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
read (<span class="method-arguments">src</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">53</span>
</span>
</div>
<div class="member-description">
<p>Reads the entire file as a string.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">src</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The source file path.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="heading-returns">Returns
<span class="type">string</span>
</div>
<div class="member"><p>description description</p></div>
</div>
</div>
<a name="documon.fileutils.remove"></a><a name="remove"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
remove (<span class="method-arguments">src</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">85</span>
</span>
</div>
<div class="member-description">
<p>Deletes a file from the system.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">src</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The source file path.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a name="documon.fileutils.save"></a><a name="save"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
save (<span class="method-arguments">src</span>, <span class="method-arguments">data</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">68</span>
</span>
</div>
<div class="member-description">
<p>Saves text data to a file. Overwrites entire file with provided data. NOTE: This is an alias for <a href="#write">write</a>.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">src</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The source file path.</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">data</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The text data to save.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a name="documon.fileutils.write"></a><a name="write"></a>
<div class="member" >
<div class="member-name clearfix">
<span class="member-name-left">
write (<span class="method-arguments">src</span>, <span class="method-arguments">data</span>)
</span>
<span class="member-name-right">
<span class="member-file">documon/src/fileutils.js</span>
<span class="member-line-number">76</span>
</span>
</div>
<div class="member-description">
<p>Saves text data to a file. Overwrites entire file with provided data.</p>
<div class="part-parameters">
<div class="heading-part">Parameters</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">src</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The source file path.</p>
</div>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<span class="member-name">data</span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="type">string</span>
<div class="member-description">
<p>The text data to save.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>