wezterm-types/doc/wezterm-types-plugin.dev.txt at main · DrKJeff16/wezterm-types · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
*wezterm-types-plugin.dev.txt*                                     `dev` types

DEV.WEZTERM ~

You can import type annotations for `ChrisGVE/dev.wezterm`
<https://github.com/ChrisGVE/dev.wezterm> as shown below:

>lua
    ---@type Dev
    local dev = wezterm.plugin.require("https://github.com/ChrisGVE/dev.wezterm")
<

This integration also adds the following events to `wezterm.on()`

- `dev.wezterm-plugin-not-found`
- `dev.wezterm.invalid_hashkey`
- `dev.wezterm.invalid_opts`
- `dev.wezterm.no_keywords`
- `dev.wezterm.require_path_not_set`

>lua
    ---Either no `hashkey` or an invalid one provided.
    ---
    ---@param event "dev.wezterm.invalid_hashkey" This is for `dev.wezterm` only!
    ---@param callback function
    function Wezterm.on(event, callback) end

    ---Invalid options provided to plugin setup.
    ---
    ---@param event "dev.wezterm.invalid_opts" This is for `dev.wezterm` only!
    ---@param callback function
    function Wezterm.on(event, callback) end

    ---No keywords were provided for searching the plugin.
    ---
    ---@param event "dev.wezterm.no_keywords" This is for `dev.wezterm` only!
    ---@param callback function
    function Wezterm.on(event, callback) end

    ---The plugin was not found and thus `package.path` could not be set.
    ---
    ---@param event "dev.wezterm.require_path_not_set" This is for `dev.wezterm` only!
    ---@param callback function
    function Wezterm.on(event, callback) end

    ---The provided keywords did not allow for the plugin to be found.
    ---
    ---@param event "dev.wezterm-plugin-not-found" This is for `dev.wezterm` only!
    ---@param callback function
    function Wezterm.on(event, callback) end
<

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl: