mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2025-01-13 08:01:05 +01:00
29 lines
1.5 KiB
Lua
29 lines
1.5 KiB
Lua
-- SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
---This file houses LDoc documentation with dummy functions.---
|
|
|
|
---Process management
|
|
---@module ProcessModule
|
|
local process_module = {}
|
|
|
|
---Spawn a process with an optional callback for its stdout, stderr, and exit information.
|
|
---
|
|
---`callback` has the following parameters:<br>
|
|
--- - `stdout` - The process's stdout printed this line.<br>
|
|
--- - `stderr` - The process's stderr printed this line.<br>
|
|
--- - `exit_code` - The process exited with this code.<br>
|
|
--- - `exit_msg` - The process exited with this message.<br>
|
|
---@tparam string|string[] command The command as one whole string or a table of each of its arguments
|
|
---@tparam function callback A callback to do something whenever the process's stdout or stderr print a line, or when the process exits.
|
|
function process_module.spawn(command, callback) end
|
|
|
|
---Spawn a process only if it isn't already running, with an optional callback for its stdout, stderr, and exit information.
|
|
---
|
|
---`callback` has the following parameters:<br>
|
|
--- - `stdout` - The process's stdout printed this line.<br>
|
|
--- - `stderr` - The process's stderr printed this line.<br>
|
|
--- - `exit_code` - The process exited with this code.<br>
|
|
--- - `exit_msg` - The process exited with this message.<br>
|
|
---@tparam string|string[] command The command as one whole string or a table of each of its arguments
|
|
---@tparam function callback A callback to do something whenever the process's stdout or stderr print a line, or when the process exits.
|
|
function process_module.spawn_once(command, callback) end
|