nodecid/types.d.js

20 lines
936 B
JavaScript
Raw Normal View History

2023-10-29 07:35:26 +00:00
/**
* @typedef {object} NodeCIConfig
* @property {string} start - Start command. Eg `node index.js`
* @property {string[] | string} preflight - And array of commands to run before
* the application starts, or a single `.sh` file path.
2023-11-06 20:06:33 +00:00
* @property {string[] | string} [postflight] - And array of commands to run after
* the application starts.
2023-10-29 07:35:26 +00:00
* @property {string} [redeploy_path] - The path to the file that will trigger a
* redeployment if content is changed. Default file path is `./REDEPLOY`
2023-10-29 12:04:21 +00:00
* @property {boolean} [first_run] - Whether to run the preflight on first run. Default `false`
2023-11-06 20:06:33 +00:00
* @property {string | number | (string | number)[]} [port] - The port to kill on reload
* @property {NodeCIBuild} [build] - Build configurations
*/
/**
* @typedef {object} NodeCIBuild
* @property {"Next.JS" | "Remix"} paradigm - The paradigm to build on
* @property {string} [out_dir] - The output Directory. Default `.dist`.
2023-10-29 07:35:26 +00:00
*/