Global

Type Definitions

DrawMode

Source:
Properties:
Name Type Description
attrs number

Text attribute flags
pair number

A color pair number
Type:
  • object

ListDirCallback(item, index) → {boolean|undefined}

Source:

Callback for module:fs.list_dir method

Parameters:
Name Type Description
item string

Directory item (file name)
index number

Index of item in directory
Returns:

Return false to stop listing

Type
boolean | undefined

Pollfd

Source:
See:
Properties:
Name Type Description
fd number

File descriptor to check
events number

Events to check (the "See" section list possible values)
revents number

Returned events (the "See" section list possible values)

A poll() descriptor

Type:
  • object

ProcExecOptions

Source:
Properties:
Name Type Description
dir string

New working directory for new process
env object

Environment variables to add/override for new process. Setting a variable to null removes it.
search_path boolean

Whether to search executable in PATH (default is true)

Process execution options.

Type:
  • object

ProcResult

Source:
Properties:
Name Type Description
value number

The child pid
exit_status number | undefined

The exit status (a number between 0 and 255) or undefined if the process exited because of a signal
term_signal number | undefined

The termination signal or undefined if the process exited normally
stop_signal number | undefined

The stop signal if the process was stopped
core_dump boolean
continued boolean

Information on a process execution result.

Type:
  • object

StatBuf

Source:
See:
Properties:
Name Type Description
gid number

Owner group id
mode number

File type and access mode
size number

Size in bytes
time TimeSpec

Time statistics
uid number

Owner user id

Return from {module:fs.stat} function holding information of a file node

Type:
  • object

SysError

Source:
Properties:
Name Type Description
errno number

A valid errno error code
message string

Error description
stack string

A human readable string with meesage and stack trace

Errors thrown when libc returns a non zero errno.

Type:
  • Error

TimeSpec

Source:
Properties:
Name Type Description
access number

Last access time
creation number

Creation time
modification number

Last modification time

Time statistics of a file node (with a resolution of one second)

Type:
  • object

WidgetListener(widget, event, props)

Source:
Parameters:
Name Type Description
widget Widget
event string
props object.<string, *>

Window

Source:
Properties:
Name Type Attributes Description
is_a string

Always contains 'Window'
handle Uint8Array

Opaque handle to window
border WindowBorder <optional>

Optional border definition
size WindowSize <optional>

Cached window size (can be missing)
draw_mode DrawMode

Window draw mode
Type:
  • object

WindowBorder

Source:
See:
Type:
  • object

WindowPadding

Source:
Properties:
Name Type Description
left number
top number
right number
bottom number
Type:
  • object

WindowPos

Source:
Properties:
Name Type Description
row number
col number
Type:
  • object

WindowSize

Source:
Properties:
Name Type Description
rows number
cols number
Type:
  • object

WinLayoutCallback(size) → {Window}

Source:
Parameters:
Name Type Description
size WindowSize
Returns:
Type
Window

WuiRunCallback(key) → {boolean}

Source:
Parameters:
Name Type Description
key number
Returns:
Type
boolean