zoriya/lz.n
1
0
Fork 0
mirror of https://github.com/zoriya/lz.n.git synced 2026-06-06 12:04:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(luacats): overload loader.load

Browse Source
This commit is contained in:
Marc Jakobi
2024-08-22 00:32:06 +02:00
parent ed49bbeb3d
commit 92c4199b44
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lua/lz/n/init.lua
+3 -2
View File
@@ -25,8 +25,9 @@ end
--- handlers' `lookup` functions to search for a plugin to load
--- (loading the first one it finds).
--- Once a plugin has been loaded, it will be removed from all handlers (via `del`).
--- As a result, calling `trigger_load` with a plugin name is idempotent.
---@param plugins string | lz.n.Plugin | string[] | lz.n.Plugin[] | table<unknown, lz.n.Plugin>
--- As a result, calling `trigger_load` with a plugin name is stateful and idempotent.
---@overload fun(plugins: lz.n.Plugin | string[] | lz.n.Plugin[] | table<unknown, lz.n.Plugin>)
---@overload fun(plugins: string | string[])
M.trigger_load = function(plugins)
require("lz.n.loader").load(plugins, M.lookup)
end
lua/lz/n/loader.lua
+2 -2
View File
@@ -98,8 +98,8 @@ local function hook(hook_key, plugin)
end
end
---@param plugins string | lz.n.Plugin | string[] | lz.n.Plugin[] | table<unknown, lz.n.Plugin>
---@param lookup? fun(name: string): lz.n.Plugin?
---@overload fun(plugins: lz.n.Plugin | string[] | lz.n.Plugin[] | table<unknown, lz.n.Plugin>)
---@overload fun(plugins: string | string[], lookup: fun(name: string): lz.n.Plugin?)
function M.load(plugins, lookup)
plugins = (type(plugins) == "string" or plugins.name) and { plugins } or plugins
---@cast plugins (string|lz.n.Plugin)[] | table<unknown, lz.n.Plugin>