Skip to content

Commit 82a797c

Browse files
authored
docs: Improve lua-language-server annotations of Job class (#526)
1 parent 0232372 commit 82a797c

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

lua/plenary/job.lua

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ local uv = vim.loop
44
local F = require "plenary.functional"
55

66
---@class Job
7-
---@field command string : Command to run
8-
---@field args Array : List of arguments to pass
9-
---@field cwd string : Working directory for job
10-
---@field env Map|Array : Environment looking like: { ['VAR'] = 'VALUE } or { 'VAR=VALUE' }
11-
---@field skip_validation boolean : Skip validating the arguments
12-
---@field enable_handlers boolean : If set to false, disables all callbacks associated with output
13-
---@field on_start function : Run when starting job
14-
---@field on_stdout function : (error: string, data: string, self? Job)
15-
---@field on_stderr function : (error: string, data: string, self? Job)
16-
---@field on_exit function : (self, code: number, signal: number)
17-
---@field maximum_results number : stop processing results after this number
18-
---@field writer Job|table|string : Job that writes to stdin of this job.
19-
---@field detached boolean : Spawn the child in a detached state making it a process group leader
20-
---@field enabled_recording boolean
7+
---@field command string Command to run
8+
---@field args? string[] List of arguments to pass
9+
---@field cwd? string Working directory for job
10+
---@field env? table<string, string>|string[] Environment looking like: { ['VAR'] = 'VALUE' } or { 'VAR=VALUE' }
11+
---@field interactive? boolean
12+
---@field detached? boolean Spawn the child in a detached state making it a process group leader
13+
---@field skip_validation? boolean Skip validating the arguments
14+
---@field enable_handlers? boolean If set to false, disables all callbacks associated with output (default: true)
15+
---@field enabled_recording? boolean
16+
---@field on_start? fun()
17+
---@field on_stdout? fun(error: string, data: string, self?: Job)
18+
---@field on_stderr? fun(error: string, data: string, self?: Job)
19+
---@field on_exit? fun(self: Job, code: number, signal: number)
20+
---@field maximum_results? number Stop processing results after this number
21+
---@field writer? Job|table|string Job that writes to stdin of this job.
2122
local Job = {}
2223
Job.__index = Job
2324

0 commit comments

Comments
 (0)