diff options
| author | Lewis Russell <lewis6991@gmail.com> | 2023-07-17 17:40:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-17 17:40:14 +0100 |
| commit | 80cf0f3d29fa337d43ec417759cb061bd2798ea8 (patch) | |
| tree | 16de8180f2fb9feefd0df94e0c8598475ec28324 /runtime/lua/vim/_meta/mpack.lua | |
| parent | 1b9ccd38a12f8fdbdff51ef0b3ff363540f745ec (diff) | |
| parent | 6e9b204afbe5f16c44a2697aed07aafff36bf856 (diff) | |
| download | rneovim-80cf0f3d29fa337d43ec417759cb061bd2798ea8.tar.gz rneovim-80cf0f3d29fa337d43ec417759cb061bd2798ea8.tar.bz2 rneovim-80cf0f3d29fa337d43ec417759cb061bd2798ea8.zip | |
Merge pull request #24363 from lewis6991/docs/luatypes
docs(lua): move some function docs to lua files
Diffstat (limited to 'runtime/lua/vim/_meta/mpack.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/mpack.lua | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/runtime/lua/vim/_meta/mpack.lua b/runtime/lua/vim/_meta/mpack.lua new file mode 100644 index 0000000000..54e097ad97 --- /dev/null +++ b/runtime/lua/vim/_meta/mpack.lua @@ -0,0 +1,15 @@ +--- @meta + +-- luacheck: no unused args + +--- @defgroup vim.mpack +--- +--- This module provides encoding and decoding of Lua objects to and +--- from msgpack-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|. + +--- Decodes (or "unpacks") the msgpack-encoded {str} to a Lua object. +--- @param str string +function vim.mpack.decode(str) end + +--- Encodes (or "packs") Lua object {obj} as msgpack in a Lua string. +function vim.mpack.encode(obj) end |