@northscaler/service-support
Version:
Artifacts that assist in writing service layers effectively
115 lines (93 loc) • 3.59 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: aspects/serviceMethod.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: aspects/serviceMethod.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>'use strict'
const { AsyncAround } = require('@northscaler/aspectify')
const servicifyOutcomeOf = require('../service/servicifyOutcomeOf')
const DateFormat = require('../enums/DateFormat')
/**
* Decorator used to execute the decorated method in a `try`/`catch` block.
* Use on service class methods only.
* If the method returns normally, the return value is wrapped in a service response object with the following shape:
*
* ```
* {
* data: <method return value>,
* meta: {
* status: ResponseStatus.SUCCESS,
* elapsedMillis: n
* }
* }
* ```
*
* If the method throws, the `Error` is caught, and formatted as a service response object with the following shape:
* ```
* {
* error: {
* name: ...,
* message: ...,
* code: ...,
* info: ...,
* cause: ...,
* stack: ...,
* },
* meta: {
* status: ResponseStatus.FAILURE,
* elapsedMillis: n
* }
* }
* ```
*
* @param {object} [arg0] The argument to be deconstructed.
* @param {Formatter[]} [arg0.formatters] Formatters to be used when formatting values in returned objects or thrown `Error`s.
* @param {boolean} [arg0.includeErrorStacks=true] Whether to include the `Error` `stack` property if one is thrown or there are `Error`s in the return value.
* Ignored if `formatters` is given.
* @param {boolean} [arg0.includeErrorCauses=true] Whether to include the `Error` `cause` property if one is thrown or there are `Error`s in the return value.
* Ignored if `formatters` is given.
* @param {DateFormat} [arg0.dateFormat=DateFormat.ISO_8601] The date format to use.
* Ignored if `formatters` is given.
*/
const serviceMethod = ({
formatters,
includeErrorStacks = true,
includeErrorCauses = true,
dateFormat = DateFormat.ISO_8601
} = {}) =>
AsyncAround(async ({ thisJoinPoint }) => servicifyOutcomeOf({
fn: thisJoinPoint.proceed,
formatters,
includeErrorStacks,
includeErrorCauses,
dateFormat
}))
module.exports = serviceMethod
</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>