Skip to content

Commit 85c2145

Browse files
authored
Merge pull request #1761 from flrgh/chore/resty-signal-type-updates
update resty.signal type annotations
2 parents e3aedae + d1fd8d3 commit 85c2145

File tree

1 file changed

+45
-36
lines changed

1 file changed

+45
-36
lines changed

meta/3rd/OpenResty/library/resty/signal.lua

Lines changed: 45 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,47 @@ local signal = {
44
version = 0.03,
55
}
66

7+
78
---@alias resty.signal.name
8-
---| '"HUP"'
9-
---| '"INT"'
10-
---| '"QUIT"'
11-
---| '"ILL"'
12-
---| '"TRAP"'
13-
---| '"ABRT"'
14-
---| '"BUS"'
15-
---| '"FPE"'
16-
---| '"KILL"'
17-
---| '"USR1"'
18-
---| '"SEGV"'
19-
---| '"USR2"'
20-
---| '"PIPE"'
21-
---| '"ALRM"'
22-
---| '"TERM"'
23-
---| '"CHLD"'
24-
---| '"CONT"'
25-
---| '"STOP"'
26-
---| '"TSTP"'
27-
---| '"TTIN"'
28-
---| '"TTOU"'
29-
---| '"URG"'
30-
---| '"XCPU"'
31-
---| '"XFSZ"'
32-
---| '"VTALRM"'
33-
---| '"PROF"'
34-
---| '"WINCH"'
35-
---| '"IO"'
36-
---| '"PWR"'
37-
---| '"EMT"'
38-
---| '"SYS"'
39-
---| '"INFO"'
40-
---| '"NONE"' # The special signal name NONE is also supported, which is mapped to zero (0).
9+
---| "NONE" # SIG_NONE
10+
---| "HUP" # SIG_HUP
11+
---| "INT" # SIG_INT
12+
---| "QUIT" # SIG_QUIT
13+
---| "ILL" # SIG_ILL
14+
---| "TRAP" # SIG_TRAP
15+
---| "ABRT" # SIG_ABRT
16+
---| "BUS" # SIG_BUS
17+
---| "FPE" # SIG_FPE
18+
---| "KILL" # SIG_KILL
19+
---| "USR1" # SIG_USR1
20+
---| "SEGV" # SIG_SEGV
21+
---| "USR2" # SIG_USR2
22+
---| "PIPE" # SIG_PIPE
23+
---| "ALRM" # SIG_ALRM
24+
---| "TERM" # SIG_TERM
25+
---| "CHLD" # SIG_CHLD
26+
---| "CONT" # SIG_CONT
27+
---| "STOP" # SIG_STOP
28+
---| "TSTP" # SIG_TSTP
29+
---| "TTIN" # SIG_TTIN
30+
---| "TTOU" # SIG_TTOU
31+
---| "URG" # SIG_URG
32+
---| "XCPU" # SIG_XCPU
33+
---| "XFSZ" # SIG_XFSZ
34+
---| "VTALRM" # SIG_VTALRM
35+
---| "PROF" # SIG_PROF
36+
---| "WINCH" # SIG_WINCH
37+
---| "IO" # SIG_IO
38+
---| "PWR" # SIG_PWR
39+
---| "EMT" # SIG_EMT
40+
---| "SYS" # SIG_SYS
41+
---| "INFO" # SIG_INFO
42+
43+
44+
---@alias resty.signal.signal
45+
---| resty.signal.name
46+
---| integer
47+
---| string
4148

4249

4350
---
@@ -48,18 +55,20 @@ local signal = {
4855
-- Signal numbers are also supported when specifying nonportable system-specific signals is desired.
4956
--
5057
---@param pid number
51-
---@param signal_name_or_num number|resty.signal.name
58+
---@param signal_name_or_num resty.signal.signal
5259
---
5360
---@return boolean ok
5461
---@return string? error
5562
function signal.kill(pid, signal_name_or_num) end
5663

64+
5765
---
5866
-- Maps the signal name specified to the system-specific signal number.
5967
-- Returns `nil` if the signal name is not known.
6068
--
61-
---@param name resty.signal.name
62-
---@return number|nil
69+
---@param name string|resty.signal.name
70+
---@return integer|nil
6371
function signal.signum(name) end
6472

73+
6574
return signal

0 commit comments

Comments
 (0)