@northscaler/service-support
Version:
Artifacts that assist in writing service layers effectively
67 lines (46 loc) • 2.24 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: formatters/enumeration-formatter.js</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">Source: formatters/enumeration-formatter.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>'use strict'
/**
* Formats the given (enumeration)[https://www.npmjs.com/package/@northscaler/enum-support].
*
* @param {object} [arg0] The argument to be deconstructed.
* @param {object} arg0.enumeration The `Enumeration` to be formatted.
* @param {boolean} [arg0.useName=true] If truey, the the `name` of the `Enumeration` will be returned, else its `ordinal`.
* @return {string} If `useName` is truey, the `name` of the `Enumeration`, else its `ordinal`.
*/
function formatEnumeration ({ enumeration, useName = true }) {
return useName ? enumeration.name : enumeration.ordinal
}
module.exports = formatEnumeration
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#DateFormat">DateFormat</a></li><li><a href="global.html#ResponseStatus">ResponseStatus</a></li><li><a href="global.html#extractDtoFromEntity">extractDtoFromEntity</a></li><li><a href="global.html#formatDate">formatDate</a></li><li><a href="global.html#formatEnumeration">formatEnumeration</a></li><li><a href="global.html#formatError">formatError</a></li><li><a href="global.html#serviceMethod">serviceMethod</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sun Oct 01 2023 23:45:36 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>