Skip to content

fix(log): update type annotations #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DrKJeff16 merged 1 commit into from
May 12, 2026
Merged

fix(log): update type annotations #164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lua/wezterm/types/plugins/log.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ function ConfigModule.setup(overrides) end
---@field formatter? Log.Sinks.FileFormatter Custom formatter. When provided, it overrides `format`.

---@class Log.Sinks.FileSink
---@operator call(Log.Event)
---@field path string Resolved destination file path.
---@field format Log.Sinks.FileFormat Output format for written entries.
---@field formatter Log.Sinks.FileFormatter|nil Custom formatter used for serialization.
Expand All @@ -88,6 +89,7 @@ function FileSink:append(payload) end
function FileSink:write(event) end

---@class Log.Sinks.Json
---@operator call(Log.Event)
local Json = {}

---Encode a Lua value to a JSON string.
Expand All @@ -112,6 +114,7 @@ function Json.write(event) end
---@field max_entries? integer Maximum stored entries. Oldest are evicted when full. 0 = unlimited. Defaults to 10 000.

---@class Log.Sinks.MemorySink
---@operator call(Log.Event)
---@field entries Log.Event[] Stored log events.
---@field max_entries integer Maximum stored entries (0 = unlimited).
local MemorySink = {}
Expand Down