Js CkPython Reference Documentation
CkJs
Current Version: 11.4.0
Chilkat.Js is a small, embeddable JavaScript engine. It executes JavaScript code inside an application without requiring a browser or large runtime like Node.js. The Chilkat Js engine began as QuickJS, but after extensive redesign, refactoring, and hardening, it has evolved into a separate JavaScript engine maintained as part of the Chilkat platform.
See About the Chilkat.Js JavaScript Engine for more information.
This software includes portions of the QuickJS JavaScript engine Copyright (c) 2017-2024 Fabrice Bellard Licensed under the MIT License. The Chilkat Js engine was originally derived from QuickJS but has been extensively modified
Object Creation
obj = chilkat.CkJs()
Properties
DebugLogFilePath
# ckStr is a CkString
js.get_DebugLogFilePath(ckStr);
strVal = js.debugLogFilePath();
js.put_DebugLogFilePath(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
# ckStr is a CkString
js.get_LastErrorHtml(ckStr);
strVal = js.lastErrorHtml();
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
# ckStr is a CkString
js.get_LastErrorText(ckStr);
strVal = js.lastErrorText();
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
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
boolVal = js.get_LastMethodSuccess();
js.put_LastMethodSuccess(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
intVal = js.get_TimeoutSeconds();
js.put_TimeoutSeconds(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.
Utf8
boolVal = js.get_Utf8();
js.put_Utf8(boolVal);
When set to True, all string arguments and return values are interpreted as UTF-8 strings. When set to False, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is True. Before v11.0.0, it was False.
VerboseLogging
boolVal = js.get_VerboseLogging();
js.put_VerboseLogging(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
Methods
CallFunction
Calls a JavaScript function. The function name and arguments are passed in func. The result is returned in result.
Returns True for success, False for failure.
CallFunctionAsync (1)
# func is a CkJsonObject
# result is a CkJsonObject
ret_task = js.CallFunctionAsync(func, result);
Creates an asynchronous task to call the CallFunction method with the arguments provided.
Returns None on failure
ConsoleOutputSb
Eval
Run jscript as a script. Return output and errors in result.
Returns True for success, False for failure.
EvalAsync (1)
# jscript is a CkStringBuilder
# result is a CkJsonObject
ret_task = js.EvalAsync(jscript, result);
Creates an asynchronous task to call the Eval method with the arguments provided.
Returns None on failure
SetCkPermission
# permission is a string
status = js.SetCkPermission(chilkatClassName, permission);
Sets sandbox related permissions for Chilkat objects. The chilkatClassName is the name of the Chilkat class (case-insensitive), such as Http, Rest, "MailMan", "Ftp2", "Ssh", etc. The chilkatClassName 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 for success, False for failure.