zombie-navigator/jsdoc/zombie/zombie.jsdoc

/**
	Zombie Navigator API (ZAPI) documentation
	
	@copyright
	Copyright © 2016  Zombie Navigator Developers
	
	<br /><br />
	
	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as
	published by the Free Software Foundation, either version 3 of the
	License, or (at your option) any later version.
	
	<br /><br />
	
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.
	
	<br /><br />
	
	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see {@link http://www.gnu.org/licenses/}.
	
	<br /><br />
	
	The latest version of the GNU AGPL should be available here:
	{@link https://www.gnu.org/licenses/agpl.html}
	
	
	@file
	@module zombie/zombie
	@license AGPL-3.0+
	@version 0.6.0
*/


/*
	This is not a script but a JSDoc documentation source.
*/


/**
	@example
const {zombie} = require('zombie/zombie');
zombie.showNotification('Version: ' + zombie.version);
	@namespace
	@public
*/
var zombie = {
	/**
		The name of this addon
		@type {string}
		@public
	*/
	productName: '',
	
	
	/**
		The version of the addon
		@type {string}
		@public
	*/
	version: '',
	
	
	/**
		The URI of the addon's license text
		@type {string}
		@public
		@since 0.5.0
	*/
	licenseURI: '',
	
	
	/**
		The name of the application
		@type {string}
		@public
	*/
	applicationName: '',
	
	
	/**
		The version of the application
		@type {string}
		@public
	*/
	applicationVersion: '',
	
	
	/**
		Show a notification to the user
		@param {string} text
		@public
	*/
	showNotification: function () {},
	
	
	/**
		Print a string to STDOUT
		@param {...string} data
		@returns {number} number of bytes written
		@public
	*/
	print: function () {},
	
	
	END_OF_NAMESPACE: true
};


/**
	Console API
	@example
	const {console} = require('zombie/zombie');
	@namespace
	@public
*/
var console = {
	/**
		@param {...string} message
		@public
	*/
	log: function () {},
	
	/**
		@param {...string} message
		@public
	*/
	error: function () {},
	
	/**
		@param {...string} message
		@public
	*/
	info: function () {},
	
	/**
		@param {...string} message
		@public
	*/
	warn: function () {},
	
	/**
		@param {...Error} exception
		@public
	*/
	exception: function () {},
	
	
	END_OF_NAMESPACE: true
};


/**
	Access environment variables (use getEnvName() to get the real (mapped)
	name of a variable)
	@example
const {env, getEnvName} = require('zombie/zombie');
env.my_variable; // may be empty ('')
getEnvName('my_variable'); // real variable name
	@since 0.4.0
	@public
	@type {object}
*/
var env = {};


/**
	Get the real name of an environment variable
	@since 0.4.0
	@public
	@param {string} name
	@returns {string}
*/
var getEnvName = function () {};


// vim: ts=4 noet ai ft=js