aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorBjörn Linse <bjorn.linse@gmail.com>2021-09-04 17:39:22 +0200
committerBjörn Linse <bjorn.linse@gmail.com>2021-09-09 16:06:43 +0200
commit0f596665ccb6f1764c2f14b8742850ab06cb9228 (patch)
tree31c636efc8b0c3ff0cb304a728d9f585e309a5a9 /runtime
parenteaf661dacd74b098de768ddc459ae2e68bb6d668 (diff)
downloadrneovim-0f596665ccb6f1764c2f14b8742850ab06cb9228.tar.gz
rneovim-0f596665ccb6f1764c2f14b8742850ab06cb9228.tar.bz2
rneovim-0f596665ccb6f1764c2f14b8742850ab06cb9228.zip
feat(lua): make vim.mpack support vim.NIL and vim.empty_dict()
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/lua.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 5d600eae99..3fd3875557 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -687,6 +687,19 @@ vim.diff({a}, {b}, {opts}) *vim.diff()*
See {opts.result_type}. nil if {opts.on_hunk} is given.
------------------------------------------------------------------------------
+VIM.MPACK *lua-mpack*
+
+The *vim.mpack* module provides packing and unpacking of lua objects to
+msgpack encoded strings. |vim.NIL| and |vim.empty_dict()| are supported.
+
+vim.mpack.pack({obj}) *vim.mpack.pack*
+ Packs a lua object {obj} and returns the msgpack representation as
+ a string
+
+vim.mpack.unpack({str}) *vim.mpack.unpack*
+ Unpacks the msgpack encoded {str} and returns a lua object
+
+------------------------------------------------------------------------------
VIM *lua-builtin*
vim.api.{func}({...}) *vim.api*