doc: getHeader need lowercase keys

zigzap · Jul 15, 2024 · 11fa66a · 11fa66a
1 parent b77bada
commit 11fa66a
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/request.zig b/src/request.zig
@@ -431,8 +431,10 @@ pub fn setContentTypeFromFilename(self: *const Self, filename: []const u8) !void
     }
 }
 
-/// Returns the header value of given key name. Returned mem is temp.
-/// Do not free it.
+/// Returns the header value of given key name.
+/// NOTE that header-names are lowerased automatically while parsing the request.
+///     so please only use lowercase keys!
+/// Returned mem is temp. Do not free it.
 pub fn getHeader(self: *const Self, name: []const u8) ?[]const u8 {
     const hname = fio.fiobj_str_new(util.toCharPtr(name), name.len);
     defer fio.fiobj_free_wrapped(hname);