kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs(lua): add vim.json (#21538)

Browse Source
This commit is contained in:
Christian Clason 2022-12-27 13:22:33 +01:00 committed by GitHub
parent 4aec442b5a
commit d215dae0e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
runtime/doc/lua.txt
View File

@ -714,6 +714,22 @@ vim.mpack.encode({obj}) *vim.mpack.encode*
vim.mpack.decode({str}) *vim.mpack.decode*
Decodes (or "unpacks") the msgpack-encoded {str} to a Lua object.
------------------------------------------------------------------------------
VIM.JSON *lua-json*
The *vim.json* module provides encoding and decoding of Lua objects to and
from JSON-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|.
vim.json.encode({obj}) *vim.json.encode*
Encodes (or "packs") Lua object {obj} as JSON in a Lua string.
vim.json.decode({str}[, {opts}]) *vim.json.decode*
Decodes (or "unpacks") the JSON-encoded {str} to a Lua object.
{opts} is a table with the key `luanil = { object: bool, array: bool }`
that controls whether `null` in JSON objects or arrays should be converted
to Lua `nil` instead of `vim.NIL`.
------------------------------------------------------------------------------
VIM.SPELL *lua-spell*