Js Lua Reference Documentation
chilkat.Js
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Js
Use
Run JavaScript code from inside the host application without launching an
external scripting process.
Start from a restricted execution environment and selectively expose only
the capabilities the script should use.
Allow scripts to use selected Chilkat classes when the host application
wants JavaScript to perform controlled Chilkat operations.
Optionally restrict filesystem access so scripts can read or write only
within approved locations.
Execute JavaScript, pass data through the host-controlled environment,
and retrieve results or diagnostics from the script run.
Use JavaScript as an embedded extension language for application-defined
workflows while keeping host resources protected.
For an extended overview, see
Js Class Overview.
Also see
About the Chilkat.Js JavaScript Engine.
Execute sandboxed JavaScript inside an application with controlled access to Chilkat features.
Chilkat.Js when an application needs to execute JavaScript
internally while retaining control over what the script is allowed to access.
By default, scripts run in a closed sandbox with the JavaScript language and
standard library available, but without filesystem, network, or Chilkat
class access unless the host application explicitly enables those
capabilities.
Embedded JavaScript engine
Sandboxed by default
Enable Chilkat classes
Filesystem restrictions
Script input and output
Controlled automation
Js object, load or provide the JavaScript code, enable
only the Chilkat classes and filesystem locations the script is permitted to
use, run the script, and inspect the result or diagnostic output. Use
Chilkat.Js when the application needs scriptability with a
security boundary controlled by the host.
Object Creation
local chilkat = require("chilkat")
local js = chilkat.Js.new()Creates the object (chilkat.Js() does the same). Lua's garbage collector frees it when it is no longer referenced; js:dispose() frees it at once, and in Lua 5.4 and later local js <close> = chilkat.Js.new() frees it when the block ends. Calling a method of a disposed object raises an error.
Errors
A method that fails returns nil followed by the error text, as io.open does: local body, err = js:method(...), where err is the object's last_error_text. Wrap the call in assert() to raise an error with that text instead. Methods that answer a question return true or false, numbers are returned as they are (check last_method_success where the description says a value means failure), and property reads and writes never fail for Chilkat reasons.
Misuse raises a Lua error: a wrong argument type or a missing argument (bad argument #1 to ...), an unknown property name, a write to a read-only property, an out-of-range integer, or an object of the wrong class.
Names are Chilkat's in snake_case: QuickGetStr is quick_get_str, LastErrorText is last_error_text. Properties are fields (js.verbose_logging = true) and methods use the colon (js:method(...)). Strings are UTF-8; binary data is a Lua string of bytes. Indexes are 0-based, as in every Chilkat API. Unlocking: call chilkat.unlock_bundle("...") once at startup.
Properties
DebugLogFilePath
local strVal = js.debug_log_file_path
js.debug_log_file_path = strVal
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
local strVal = js.last_error_html
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
local strVal = js.last_error_text
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
local strVal = js.last_error_xml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
local boolVal = js.last_method_success
js.last_method_success = boolVal
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
TimeoutSeconds
local intVal = js.timeout_seconds
js.timeout_seconds = intVal
Specify a timeout in seconds to prevent JavaScript from running indefinitely, such as in an infinite loop. By default, the value is 0, meaning no timeout is set and infinite loops will continue forever.
VerboseLogging
local boolVal = js.verbose_logging
js.verbose_logging = boolVal
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
local strVal = js.version
Methods
CallFunction
-- result_json is a chilkat.JsonObject
-- ok is true, or nil and err on failure
local ok, err = js:call_function(func_json, result_json)
Calls a JavaScript function. The function name and arguments are passed in func_json. The result is returned in result_json.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
ConsoleOutputSb
Eval
-- result_json is a chilkat.JsonObject
-- ok is true, or nil and err on failure
local ok, err = js:eval(jscript, result_json)
Run jscript as a script. Return output and errors in result_json.
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.
SetCkPermission
-- permission is a string
-- ok is true, or nil and err on failure
local ok, err = js:set_ck_permission(chilkat_class_name, permission)
Sets sandbox related permissions for Chilkat objects. The chilkat_class_name is the name of the Chilkat class (case-insensitive), such as Http, Rest, "MailMan", "Ftp2", "Ssh", etc. The chilkat_class_name can also be set to "all" to apply the permission to all Chilkat classes.
Possible values for permission are:
disable- Your JavaScript code is not allowed to create an instance of the Chilkat class. A JavaScript exception is thrown when trying to create a Chilkat object of a class that is disabled.sandbox- Objects for the Chilkat class can be instantiated in JavaScript, but they have no read or write access to the local filesystem.readOnly- Objects for the Chilkat class can be instantiated in JavaScript and have read-only access to the local filesystem.writeOnly- Objects for the Chilkat class can be instantiated in JavaScript and have write-only access to the local filesystem.readWrite- Objects for the Chilkat class can be instantiated in JavaScript and have read/write access to the local filesystem.
By default, all Chilkat classes are disabled. Your application must enable "all" or specific Chilkat classes before calling Eval or CallFunction .
Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.