File

Reference for the file API.

WARNING

Paths are limited to the Lexis folder, trying to use a path in another directory will fail.

Functions

file.exists

If a file exists.

---@param path string
function file.exists(path): bool

file.remove

Deletes a file.

---@param path string
function file.remove(path): bool

file.open

Deletes a file.

---@param path string
---@param options { append: bool, create_if_not_exists: bool }
function file.open(path, options): file

Types

file

Field	Type
valid	bool
text	string
json	json

Examples

local handle = file.open(paths.cheat .. 'test.txt', { create_if_not_exists: true })
if handle.valid then
  handle.text = 'this is test text'
end