d925da47fa
* feat(system): add system.ftruncate * fix: EPERM writing to hidden files on Windows * chore(doc): fix capitalization * refactor(system): make ftruncate length optional * refactor(doc): don't specify length |
||
|---|---|---|
| .. | ||
| api | ||
| README.md | ||
README.md
Interface Files
This directory holds the documentation for the Lua C API that is hidden in the C source files of Lite. The idea of these files is to serve you as a quick reference about the functionality that is not written in Lua it self. Please note that they don't have any real code, just metadata or annotations.
Also, these interfaces are using EmmyLua annotation syntax which is supported by LSP servers like the Sumneko Lua LSP. This means that you can get nice code autocompletion and descriptions of Lite core libraries and symbols when developing plugins or adding any options to your User Module File (init.lua).
The Base Core
Most of the code that is written in Lua for Lite is powered by the exposed C API in the four namespaces that follow:
Finally, all global variables are documented in the file named globals.lua.