lib-songbeamer
Version:
transforming SongBeamer Song-Files and Ablaufplan-Files
670 lines (173 loc) • 7.26 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: song</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: song</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">Gets Json from and json to song-files</div>
<dl class="details">
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li>1.0</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Dominik Sigmund</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_song.js.html">libs/song.js</a>, <a href="libs_song.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".toFile"><span class="type-signature">(static) </span>toFile<span class="signature">(json, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Write Json to a File String
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">String as delivered by fs.readFile</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="song.html#~stringCallback">song~stringCallback</a></span>
</td>
<td class="description last">A Callback with an error or the String as delivered to fs.writeFile</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_song.js.html">libs/song.js</a>, <a href="libs_song.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Nothing
</div>
<h4 class="name" id=".toJSON"><span class="type-signature">(static) </span>toJSON<span class="signature">(data, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Get Json from a string
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">String as delivered by fs.readFile</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="song.html#~jsonCallback">song~jsonCallback</a></span>
</td>
<td class="description last">A Callback with an error or the Json</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_song.js.html">libs/song.js</a>, <a href="libs_song.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Nothing
</div>
<h4 class="name" id="~isCaption"><span class="type-signature">(inner) </span>isCaption<span class="signature">(text)</span><span class="type-signature"> → {bool}</span></h4>
<div class="description">
Checks if a string is a caption (Vers, Bridge, Chorus, ...)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A Line of Text</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_song.js.html">libs/song.js</a>, <a href="libs_song.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- True, if is a caption, else false
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">bool</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ablauf.html">ablauf</a></li><li><a href="module-index.html">index</a></li><li><a href="module-song.html">song</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 04 2018 16:30:08 GMT+0100 (Mitteleuropäische Zeit)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>