leasehold-http-api/helpers/swagger_module_registry.js

HTTP API module for Leasehold sidechain

/*
 * Copyright © 2019 Lisk Foundation
 *
 * See the LICENSE file at the top-level directory of this distribution
 * for licensing information.
 *
 * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
 * no part of this software, including this file, may be copied, modified,
 * propagated, or distributed except according to the terms contained in the
 * LICENSE file.
 *
 * Removal or modification of this copyright notice is prohibited.
 */

'use strict';

// Private fields
let __private = {};

/**
 * Description of the module.
 *
 * @module
 * @see Parent: {@link helpers}
 * @todo Add description for the module
 */

/**
 * A module to reference the scope of the application between swagger pipeline.
 *
 * @param {Object} scope - Application scope
 */
function bind(scope) {
	__private = {
		config: scope.config,
		cache: scope.components ? scope.components.cache : undefined,
		logger: scope.components.logger,
	};
}

/**
 * Get cache module.
 *
 * @returns {Object}
 * @todo Add description for the return value
 */
function getCache() {
	return __private.cache;
}

/**
 * Get system logger.
 *
 * @returns {Object}
 * @todo Add description for the return value
 */
function getLogger() {
	return __private.logger;
}

/**
 * Get system config.
 *
 * @returns {Object}
 * @todo Add description for the return value
 */
function getConfig() {
	return __private.config;
}

module.exports = {
	bind,
	getCache,
	getLogger,
	getConfig,
};