Skip to content
Permalink
Browse files

docs(maker): document the return result of make

  • Loading branch information
MarshallOfSound authored and malept committed Aug 27, 2017
1 parent f8d807e commit 5399f500187456358fca5c65c2362198a6698980
Showing with 9 additions and 1 deletion.
  1. +9 −1 src/api/make.js
@@ -24,11 +24,19 @@ import packager from './package';
* @property {string} [outDir=`${dir}/out`] The path to the directory containing generated distributables
*/

/**
* @typedef {Object} MakeResult
* @property {Array<string>} artifacts An array of paths to artifacts generated for this make run
* @property {Object} packageJSON The state of the package.json file when the make happened
* @property {string} platform The platform this make run was for
* @property {string} arch The arch this make run was for
*/

/**
* Make distributables for an Electron application.
*
* @param {MakeOptions} providedOptions - Options for the make method
* @return {Promise} Will resolve when the make process is complete
* @return {Promise<Array<MakeResult>>} Will resolve when the make process is complete
*/
export default async (providedOptions = {}) => {
// eslint-disable-next-line prefer-const, no-unused-vars

0 comments on commit 5399f50

Please sign in to comment.
You can’t perform that action at this time.