You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: meta/3rd/OpenResty/library/ngx.lua
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -2503,7 +2503,7 @@ function ngx.req.discard_body() end
2503
2503
--- ```
2504
2504
---
2505
2505
---@paramheader_namestring
2506
-
---@paramheader_valuestring|string[]
2506
+
---@paramheader_valuestring|string[]|nil
2507
2507
functionngx.req.set_header(header_name, header_value) end
2508
2508
2509
2509
--- Retrieves in-memory request body data. It returns a Lua string rather than a Lua table holding all the parsed query arguments. Use the `ngx.req.get_post_args` function instead if a Lua table is required.
@@ -3009,7 +3009,7 @@ function tcpsock:receive(pattern) end
3009
3009
---
3010
3010
--- This method doesn't automatically close the current connection when the read timeout error occurs. For other connection errors, this method always automatically closes the connection.
3011
3011
---
3012
-
---@parammaxstring
3012
+
---@parammaxinteger
3013
3013
---@returnstring?data
3014
3014
---@returnstring?error
3015
3015
functiontcpsock:receiveany(max) end
@@ -3138,9 +3138,9 @@ function tcpsock:settimeout(time) end
3138
3138
---
3139
3139
--- Note that this method does *not* affect the `lua_socket_keepalive_timeout` setting; the `timeout` argument to the `setkeepalive` method should be used for this purpose instead.
3140
3140
---
3141
-
---@paramconnect_timeoutnumber
3142
-
---@paramsend_timeoutnumber
3143
-
---@paramread_timeoutnumber
3141
+
---@paramconnect_timeoutnumber|nil
3142
+
---@paramsend_timeoutnumber|nil
3143
+
---@paramread_timeoutnumber|nil
3144
3144
functiontcpsock:settimeouts(connect_timeout, send_timeout, read_timeout) end
3145
3145
3146
3146
@@ -3294,7 +3294,7 @@ function tcpsock:getreusedtimes() end
3294
3294
---@paramport?number
3295
3295
---@returntcpsock?socket
3296
3296
---@returnstring?error
3297
-
functionngx.socket.connect(host,port) end
3297
+
functionngx.socket.connect(host,port) end
3298
3298
3299
3299
--- Creates and returns a UDP or datagram-oriented unix domain socket object (also known as one type of the "cosocket" objects). The following methods are supported on this object:
3300
3300
---
@@ -4007,7 +4007,7 @@ function ngx.location.capture_multi(args) end
4007
4007
---
4008
4008
--- For reading *request* headers, use the `ngx.req.get_headers` function instead.
4009
4009
---
4010
-
---@typetable<string, any>
4010
+
---@typetable<string, string|string[]|nil>
4011
4011
ngx.header= {}
4012
4012
4013
4013
@@ -4101,7 +4101,7 @@ function ngx.time() end
4101
4101
--- There is a hard coded `2048` byte limitation on error message lengths in the NGINX core. This limit includes trailing newlines and leading time stamps. If the message size exceeds this limit, NGINX will truncate the message text accordingly. This limit can be manually modified by editing the `NGX_MAX_ERROR_STR` macro definition in the `src/core/ngx_log.h` file in the NGINX source tree.
0 commit comments