src/typedef/index.js

/**
 * Roc builder object.
 *
 * @typedef {Object} rocBuilder
 * @property {object} buildConfig - Webpack config object, can be used to extend the configuration.
 * @property {object} builder - Webpack instance.
 * @see https://webpack.github.io/
 */

/**
 * Output path object.
 *
 * @typedef {Object} outputPath
 * @property {!string} absolute - Absolute path to where the build should be saved on disk.
 * @property {!string} relative - Relative path to where the build should be saved on disk, based on from where the
 * command is run from.
 */

/**
 * Roc server.
 *
 * @typedef {Object} rocServer
 * @property {object} server - Koa instance.
 * @property {startServer} start - Starts the server.
 */

 /**
 * Starts a server.
 *
 * The port for the server to start on can be selected in 3 ways and has priority in the same order.
 * 1. The param for the function, `port`
 * 2. Environment variable, `PORT`
 * 3. The port from `roc.config.js`
 *
 * @typedef {function} startServer
 * @param {number} [port=PORT/roc.config.js] - the port to start the server on.
 */

/**
 * Roc server options.
 *
 * Used in {@link createServer}.
 *
 * Both of these options can also be set in `roc.config.js` however these values will override them if provided.
 *
 * @typedef {Object} rocServerOptions
 * @property {string|string[]} [serve] - The folders to serve from the server. Paths will be based from where the
 * application is started.
 * @property {string} [favicon] - The path to the favicon. This file will be handled in the server in a special way.
 */