lux-utils
Version:
JS library to validate and format common Luxembourgish administrative data.
81 lines (58 loc) • 2.34 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>init/init.js - Documentation</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="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="YourLibrary.html">YourLibrary</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="YourLibrary.html#.init">init</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">init/init.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* @memberof YourLibrary
* @function init
* @description Return the message + ' world'
* @param {Object} options (see attributes below)
* @param {String} [options.message=''] message to show
* @returns {String} Your message + ' world'
*
* @example
* // Initialize YourLibrary
* var foo = YourLibrary.init({
* message: 'hello'
* });
* console.log(foo);
*/
export default (options) => {
const newMessage = `${options.message} world`;
return newMessage;
};</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Sep 21 2018 11:35:31 GMT+0200 (CEST) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>