Suite.js Documentation

Introduction


Getting Started

• Downloading & Installing
• Running
Examples


Technical Support


Functions

Cryptography
• hashSHA256
• hmacSHA256
• hashSHA512
• hmacSHA512
• hashMD5
• hmacMD5

File System
fileExists
fileRead
fileWrite
folderExists
unzip
zip

Input / Output
beep
prompt
write
writeln

Networking
curlExecute
• nsapiExecute

Operating System
shellExecute

Text Encoding
base64Decode
base64Encode


Advanced Topics

fileRead

Returns the content of a file at the specified location.

fileRead Example

<span class="com">// Specify the path to the file.</span><span class="pln">
</span><span class="kwd">var</span><span class="pln"> filepath </span><span class="pun">=</span><span class="pln"> info</span><span class="pun">.</span><span class="pln">sourceFile</span><span class="pun">.</span><span class="pln">parentNativePath </span><span class="pun">+</span><span class="pln"> </span><span class="str">"/../"</span><span class="pun">;</span><span class="pln">

</span><span class="com">// If the path (folder) doesn't exist...</span><span class="pln">
</span><span class="kwd">if</span><span class="pun">(</span><span class="pln"> </span><span class="pun">!</span><span class="pln"> folderExists</span><span class="pun">(</span><span class="pln"> filepath </span><span class="pun">)</span><span class="pln"> </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
	writeln</span><span class="pun">(</span><span class="pln"> </span><span class="str">"ERROR: The folder ("</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> filepath </span><span class="pun">+</span><span class="pln"> </span><span class="str">" does not exist."</span><span class="pln"> </span><span class="pun">);</span><span class="pln">	quit</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln">

</span><span class="com">// Specify the filename.</span><span class="pln">
</span><span class="kwd">var</span><span class="pln"> filename </span><span class="pun">=</span><span class="pln"> </span><span class="str">"License.txt"</span><span class="pun">;</span><span class="pln">

</span><span class="com">// If the file doesn't exist...</span><span class="pln">
</span><span class="kwd">if</span><span class="pun">(</span><span class="pln"> </span><span class="pun">!</span><span class="pln"> fileExists</span><span class="pun">(</span><span class="pln"> filepath </span><span class="pun">+</span><span class="pln"> filename </span><span class="pun">)</span><span class="pln"> </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
	writeln</span><span class="pun">(</span><span class="pln"> </span><span class="str">"ERROR: The file ("</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> filepath </span><span class="pun">+</span><span class="pln"> filename </span><span class="pun">)</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> </span><span class="str">") does not exist."</span><span class="pln"> </span><span class="pun">);</span><span class="pln">	quit</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln">

</span><span class="com">// Read the file.</span><span class="pln">
</span><span class="kwd">var</span><span class="pln"> fileContents </span><span class="pun">=</span><span class="pln"> fileRead</span><span class="pun">(</span><span class="pln"> filepath </span><span class="pun">+</span><span class="pln"> filename </span><span class="pun">);</span><span class="pln">

</span><span class="kwd">if</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> info</span><span class="pun">.</span><span class="pln">error</span><span class="pun">.</span><span class="pln">type </span><span class="pun">!=</span><span class="pln"> </span><span class="kwd">null</span><span class="pln"> </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
	writeln</span><span class="pun">(</span><span class="pln"> </span><span class="str">"ERROR: "</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> info</span><span class="pun">.</span><span class="pln">error</span><span class="pun">.</span><span class="pln">type </span><span class="pun">);</span><span class="pln">	
	quit</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln">

writeln</span><span class="pun">(</span><span class="pln"> </span><span class="str">'File Contents:'</span><span class="pln"> </span><span class="pun">);</span><span class="pln">
writeln</span><span class="pun">;</span><span class="pln">
writeln</span><span class="pun">(</span><span class="pln"> stringIndent</span><span class="pun">(</span><span class="pln"> fileContents</span><span class="pun">,</span><span class="pln"> </span><span class="lit">5</span><span class="pln"> </span><span class="pun">)</span><span class="pln"> </span><span class="pun">);</span><span class="pln">
writeln</span><span class="pun">;</span>

© Copyright 2025 Tim Dietrich. | Legal Info