mirage-config/docs/mirage/json.html

131 lines
3.7 KiB
HTML
Raw Normal View History

2022-10-09 00:10:05 +02:00
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
<title>Module mirage.json</title>
<link rel="stylesheet" href="../css/style.min.css"/>
<script type="text/javascript" src="../js/script.min.js"></script>
</head>
<body onload="setupDdox();">
<header></header>
<nav id="main-nav">
<div>
<noscript>
<p style="color: red">The search functionality needs JavaScript enabled</p>
</noscript>
<div id="symbolSearchPane" style="display: none">
<form action="#" method="GET">
<input id="symbolSearch" type="text" name="q" placeholder="Search for symbols" autocomplete="off" onchange="performSymbolSearch(24);" onkeypress="this.onchange();" onpaste="this.onchange();" oninput="this.onchange();" autofocus/>
</form>
<ul id="symbolSearchResults" class="symbolList" style="display: none"></ul><script type="application/javascript" src="../symbols.js"></script><script type="application/javascript">var symbolSearchRootDir = "../";
document.getElementById('symbolSearchPane').style.display = 'block';</script>
</div>
<ul class="tree-view">
<li class="tree-view ">
<div class="package ">
<a href="../mirage.html">mirage</a>
</div>
<ul class="tree-view">
<li>
<div class="module ">
<a href="../mirage/config.html">config</a>
</div>
</li>
<li>
<div class="module ">
<a href="../mirage/java.html">java</a>
</div>
</li>
<li>
<div class="module selected">
<a href="../mirage/json.html">json</a>
</div>
</li>
</ul>
</li>
</ul>
</div>
<p id="main-nav-footer">
Built with
<a href="https://github.com/MartinNowak/scod">scod</a>
</p>
</nav>
<div id="main-contents">
<div>
<h1>Module mirage.json</h1><p>Utilities for loading JSON configurations.
</p><section></section>
<section></section>
<section>
<h2>Functions</h2>
<table>
<col class="caption"/>
<tr>
<th>Name</th><th>Description</th>
</tr>
<tr>
<td>
<code>
<a id="loadJsonConfig" class="public" href="../mirage/json/loadJsonConfig.html">loadJsonConfig</a><span class="tableEntryAnnotation">(filePath)</span>
</code>
</td>
<td>Load a JSON configuration file from disk.
</td>
</tr>
<tr>
<td>
<code>
<a id="parseJsonConfig" class="public" href="../mirage/json/parseJsonConfig.html">parseJsonConfig</a><span class="tableEntryAnnotation">(json)</span>
</code>
</td>
<td>Parse JSON config from the given JSON string.
</td>
</tr>
<tr>
<td>
<code>
<a id="parseJsonConfig" class="public" href="../mirage/json/parseJsonConfig.html">parseJsonConfig</a><span class="tableEntryAnnotation">(json)</span>
</code>
</td>
<td>Parse JSON config from the given JSONValue.
</td>
</tr>
</table>
</section>
<section>
<h2>Classes</h2>
<table>
<col class="caption"/>
<tr>
<th>Name</th><th>Description</th>
</tr>
<tr>
<td>
<code>
<a id="JsonConfigFactory" class="public" href="../mirage/json/JsonConfigFactory.html">JsonConfigFactory</a>
</code>
</td>
<td>Creates configuration dictionaries from JSONs.
</td>
</tr>
</table>
</section>
</div>
<footer>
<div id="license-info">
<p>Mike Bierlee, m.bierlee@lostmoment.com
</p>
<p>2022 Mike Bierlee
</p>
<p>This software is licensed under the terms of the MIT license.
The full terms of the license can be found in the LICENSE file.
</p>
</div>
</footer>
</div>
</body>
</html>