| JsAddRef⚠ |
Adds a reference to a garbage collected object.
This only needs to be called on JsRef handles that are not going to be stored
somewhere on the stack. Calling JsAddRef ensures that the object the JsRef
refers to will not be freed until JsRelease is called.
The object to add a reference to.
The object's new reference count (can pass in null).
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsBoolToBoolean⚠ |
Creates a Boolean value from a bool value.
Requires an active script context.
The value to be converted.
The converted value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsBooleanToBool⚠ |
Retrieves the bool value of a Boolean value.
The value to be converted.
The converted value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCallFunction⚠ |
Invokes a function.
Requires thisArg as first argument of arguments.
Requires an active script context.
The function to invoke.
The arguments to the call.
The number of arguments being passed in to the function.
The value returned from the function invocation, if any.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCollectGarbage⚠ |
Performs a full garbage collection.
The runtime in which the garbage collection will be performed.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsConstructObject⚠ |
Invokes a function as a constructor.
Requires an active script context.
The function to invoke as a constructor.
The arguments to the call.
The number of arguments being passed in to the function.
The value returned from the function invocation.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsConvertValueToBoolean⚠ |
Converts the value to Boolean using standard JavaScript semantics.
Requires an active script context.
The value to be converted.
The converted value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsConvertValueToNumber⚠ |
Converts the value to number using standard JavaScript semantics.
Requires an active script context.
The value to be converted.
The converted value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsConvertValueToObject⚠ |
Converts the value to object using standard JavaScript semantics.
Requires an active script context.
The value to be converted.
The converted value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsConvertValueToString⚠ |
Converts the value to string using standard JavaScript semantics.
Requires an active script context.
The value to be converted.
The converted value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCopyPropertyId⚠ |
Copies the name associated with the property ID into a buffer.
Requires an active script context.
When size of the buffer is unknown,
buffer argument can be nullptr.
length argument will return the size needed.
The property ID to get the name of.
The buffer holding the name associated with the property ID, encoded as utf8
Size of the buffer.
Total number of characters written or to be written
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCopyString⚠ |
Write JavascriptString value into C string buffer (Utf8)
When size of the buffer is unknown,
buffer argument can be nullptr.
In that case, written argument will return the length needed.
JavascriptString value
Pointer to buffer
Buffer size
Total number of characters written
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCopyStringUtf16⚠ |
Write string value into Utf16 string buffer
When size of the buffer is unknown,
buffer argument can be nullptr.
In that case, written argument will return the length needed.
when start is out of range or < 0, returns JsErrorInvalidArgument
and written will be equal to 0.
If calculated length is 0 (It can be due to string length or start
and length combination), then written will be equal to 0 and call
returns JsNoError
JavascriptString value
start offset of buffer
length to be written
Pointer to buffer
Total number of characters written
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateArray⚠ |
Creates a Javascript array object.
Requires an active script context.
The initial length of the array.
The new array object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateArrayBuffer⚠ |
Creates a Javascript ArrayBuffer object.
Requires an active script context.
The number of bytes in the ArrayBuffer.
The new ArrayBuffer object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateContext⚠ |
Creates a script context for running scripts.
Each script context has its own global object that is isolated from all other script
contexts.
The runtime the script context is being created in.
The created script context.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateDataView⚠ |
Creates a Javascript DataView object.
Requires an active script context.
An existing ArrayBuffer object to use as the storage for the result DataView object.
The offset in bytes from the start of arrayBuffer for result DataView to reference.
The number of bytes in the ArrayBuffer for result DataView to reference.
The new DataView object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateError⚠ |
Creates a new JavaScript error object
Requires an active script context.
Message for the error object.
The new error object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateExternalArrayBuffer⚠ |
Creates a Javascript ArrayBuffer object to access external memory.
Requires an active script context.
A pointer to the external memory.
The number of bytes in the external memory.
A callback for when the object is finalized. May be null.
User provided state that will be passed back to finalizeCallback.
The new ArrayBuffer object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateExternalObject⚠ |
Creates a new object that stores some external data.
Requires an active script context.
External data that the object will represent. May be null.
A callback for when the object is finalized. May be null.
The new object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateFunction⚠ |
Creates a new JavaScript function.
Requires an active script context.
The method to call when the function is invoked.
User provided state that will be passed back to the callback.
The new function object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateNamedFunction⚠ |
Creates a new JavaScript function with name.
Requires an active script context.
The name of this function that will be used for diagnostics and stringification purposes.
The method to call when the function is invoked.
User provided state that will be passed back to the callback.
The new function object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateObject⚠ |
Creates a new object.
Requires an active script context.
The new object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreatePromise⚠ |
Creates a new JavaScript Promise object.
Requires an active script context.
The new Promise object.
The function called to resolve the created Promise object.
The function called to reject the created Promise object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreatePropertyId⚠ |
Creates the property ID associated with the name.
Property IDs are specific to a context and cannot be used across contexts.
Requires an active script context.
The name of the property ID to get or create. The name may consist of only digits.
The string is expected to be ASCII / utf8 encoded.
length of the name in bytes
The property ID in this runtime for the given name.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateRangeError⚠ |
Creates a new JavaScript RangeError error object
Requires an active script context.
Message for the error object.
The new error object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateReferenceError⚠ |
Creates a new JavaScript ReferenceError error object
Requires an active script context.
Message for the error object.
The new error object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateRuntime⚠ |
Creates a new runtime.
The attributes of the runtime to be created.
The thread service for the runtime. Can be null.
The runtime created.
In the edge-mode binary, chakra.dll, this function lacks the runtimeVersion
parameter (compare to jsrt9.h).
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateString⚠ |
Create JavascriptString variable from ASCII or Utf8 string
Input string can be either ASCII or Utf8
Pointer to string memory.
Number of bytes within the string
JsValueRef representing the JavascriptString
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateStringUtf16⚠ |
Create JavascriptString variable from Utf16 string
Expects Utf16 string
Pointer to string memory.
Number of characters within the string
JsValueRef representing the JavascriptString
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateSymbol⚠ |
Creates a Javascript symbol.
Requires an active script context.
The string description of the symbol. Can be null.
The new symbol.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateSyntaxError⚠ |
Creates a new JavaScript SyntaxError error object
Requires an active script context.
Message for the error object.
The new error object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateTypeError⚠ |
Creates a new JavaScript TypeError error object
Requires an active script context.
Message for the error object.
The new error object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateTypedArray⚠ |
Creates a Javascript typed array object.
The baseArray can be an ArrayBuffer, another typed array, or a JavaScript
Array. The returned typed array will use the baseArray if it is an ArrayBuffer, or
otherwise create and use a copy of the underlying source array.
Requires an active script context.
The type of the array to create.
The base array of the new array. Use JS_INVALID_REFERENCE if no base array.
The offset in bytes from the start of baseArray (ArrayBuffer) for result typed array to reference.
Only applicable when baseArray is an ArrayBuffer object. Must be 0 otherwise.
The number of elements in the array. Only applicable when creating a new typed array without
baseArray (baseArray is JS_INVALID_REFERENCE) or when baseArray is an ArrayBuffer object.
Must be 0 otherwise.
The new typed array object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateURIError⚠ |
Creates a new JavaScript URIError error object
Requires an active script context.
Message for the error object.
The new error object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsCreateWeakReference⚠ |
Creates a weak reference to a value.
The value to be referenced.
Weak reference to the value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsDefineProperty⚠ |
Defines a new object's own property from a property descriptor.
Requires an active script context.
The object that has the property.
The ID of the property.
The property descriptor.
Whether the property was defined.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsDeleteIndexedProperty⚠ |
Delete the value at the specified index of an object.
Requires an active script context.
The object to operate on.
The index to delete.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsDeleteProperty⚠ |
Deletes an object's property.
Requires an active script context.
The object that contains the property.
The ID of the property.
The property set should follow strict mode rules.
Whether the property was deleted.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsDiagEvaluate⚠ |
Evaluates an expression on given frame.
Javascript String or ArrayBuffer (incl. ExternalArrayBuffer).
Index of stack frame on which to evaluate the expression.
Defines how expression (JsValueRef) should be parsed.
- JsParseScriptAttributeNone when expression is a Utf8 encoded ArrayBuffer and/or a Javascript String (encoding independent)
- JsParseScriptAttributeArrayBufferIsUtf16Encoded when expression is Utf16 Encoded ArrayBuffer
- JsParseScriptAttributeLibraryCode has no use for this function and has similar effect with JsParseScriptAttributeNone
Forces the result to contain the raw value of the expression result.
Result of evaluation.
evalResult when evaluating 'this' and return is JsNoError
{
"name" : "this",
"type" : "object",
"className" : "Object",
"display" : "{...}",
"propertyAttributes" : 1,
"handle" : 18
}
|
| JsDiagGetBreakOnException⚠ |
Gets break on exception setting.
Runtime from which to get break on exception attributes, should be in debug mode.
Mask of JsDiagBreakOnExceptionAttributes.
The code JsNoError if the operation succeeded, a failure code otherwise.
The runtime should be in debug state. This API can be called from another runtime.
|
| JsDiagGetBreakpoints⚠ |
List all breakpoints in the current runtime.
Array of breakpoints.
[{
"breakpointId" : 1,
"scriptId" : 1,
"line" : 0,
"column" : 62
}]
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can be called when runtime is at a break or running.
|
| JsDiagGetFunctionPosition⚠ |
Gets the source information for a function object.
JavaScript function.
Function position - scriptId, start line, start column, line number of first statement, column number of first statement.
{
"scriptId" : 1,
"fileName" : "c:\Test\Test.js",
"line" : 1,
"column" : 2,
"firstStatementLine" : 6,
"firstStatementColumn" : 0
}
The code JsNoError if the operation succeeded, a failure code otherwise.
This API can be called when runtime is at a break or running.
|
| JsDiagGetObjectFromHandle⚠ |
Gets the object corresponding to handle.
Handle of object.
Object corresponding to the handle.
{
"scriptId" : 24,
"line" : 1,
"column" : 63,
"name" : "foo",
"type" : "function",
"handle" : 2
}
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can only be called when runtime is at a break.
|
| JsDiagGetProperties⚠ |
Gets the list of children of a handle.
Handle of object.
0-based from count of properties, usually 0.
Number of properties to return.
Array of properties.
Handle should be from objects returned from call to JsDiagGetStackProperties.
For scenarios where object have large number of properties totalCount can be used to control how many properties are given.
{
"totalPropertiesOfObject": 10,
"properties" : [{
"name" : "__proto__",
"type" : "object",
"display" : "{...}",
"className" : "Object",
"propertyAttributes" : 1,
"handle" : 156
}
],
"debuggerOnlyProperties" : [{
"name" : "[Map]",
"type" : "string",
"value" : "size = 0",
"propertyAttributes" : 2,
"handle" : 157
}
]
}
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can only be called when runtime is at a break.
|
| JsDiagGetScripts⚠ |
Gets list of scripts.
Array of script objects.
[{
"scriptId" : 2,
"fileName" : "c:\Test\Test.js",
"lineCount" : 4,
"sourceLength" : 111
}, {
"scriptId" : 3,
"parentScriptId" : 2,
"scriptType" : "eval code",
"lineCount" : 1,
"sourceLength" : 12
}]
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can be called when runtime is at a break or running.
|
| JsDiagGetSource⚠ |
Gets source for a specific script identified by scriptId from JsDiagGetScripts.
Id of the script.
Source object.
{
"scriptId" : 1,
"fileName" : "c:\Test\Test.js",
"lineCount" : 12,
"sourceLength" : 15154,
"source" : "var x = 1;"
}
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can be called when runtime is at a break or running.
|
| JsDiagGetStackProperties⚠ |
Gets the list of properties corresponding to the frame.
Index of stack frame from JsDiagGetStackTrace.
Object of properties array (properties, scopes and globals).
propertyAttributes is a bit mask of
NONE = 0x1,
HAVE_CHILDRENS = 0x2,
READ_ONLY_VALUE = 0x4,
{
"thisObject": {
"name": "this",
"type" : "object",
"className" : "Object",
"display" : "{...}",
"propertyAttributes" : 1,
"handle" : 306
},
"exception" : {
"name" : "{exception}",
"type" : "object",
"display" : "'a' is undefined",
"className" : "Error",
"propertyAttributes" : 1,
"handle" : 307
}
"arguments" : {
"name" : "arguments",
"type" : "object",
"display" : "{...}",
"className" : "Object",
"propertyAttributes" : 1,
"handle" : 190
},
"returnValue" : {
"name" : "[Return value]",
"type" : "undefined",
"propertyAttributes" : 0,
"handle" : 192
},
"functionCallsReturn" : [{
"name" : "[foo1 returned]",
"type" : "number",
"value" : 1,
"propertyAttributes" : 2,
"handle" : 191
}
],
"locals" : [],
"scopes" : [{
"index" : 0,
"handle" : 193
}
],
"globals" : {
"handle" : 194
}
}
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can only be called when runtime is at a break.
|
| JsDiagGetStackTrace⚠ |
Gets the stack trace information.
Stack trace information.
[{
"index" : 0,
"scriptId" : 2,
"line" : 3,
"column" : 0,
"sourceLength" : 9,
"sourceText" : "var x = 1",
"functionHandle" : 1
}]
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can only be called when runtime is at a break.
|
| JsDiagRemoveBreakpoint⚠ |
Remove a breakpoint.
Breakpoint id returned from JsDiagSetBreakpoint.
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can be called when runtime is at a break or running.
|
| JsDiagRequestAsyncBreak⚠ |
Request the runtime to break on next JavaScript statement.
Runtime to request break.
The code JsNoError if the operation succeeded, a failure code otherwise.
The runtime should be in debug state. This API can be called from another runtime.
|
| JsDiagSetBreakOnException⚠ |
Sets break on exception handling.
Runtime to set break on exception attributes.
Mask of JsDiagBreakOnExceptionAttributes to set.
If this API is not called the default value is set to JsDiagBreakOnExceptionAttributeUncaught in the runtime.
The code JsNoError if the operation succeeded, a failure code otherwise.
The runtime should be in debug state. This API can be called from another runtime.
|
| JsDiagSetBreakpoint⚠ |
Sets breakpoint in the specified script at give location.
Id of script from JsDiagGetScripts or JsDiagGetSource to put breakpoint.
0 based line number to put breakpoint.
0 based column number to put breakpoint.
Breakpoint object with id, line and column if success.
{
"breakpointId" : 1,
"line" : 2,
"column" : 4
}
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can be called when runtime is at a break or running.
|
| JsDiagSetStepType⚠ |
Sets the step type in the runtime after a debug break.
Requires to be at a debug break.
Type of JsDiagStepType.
The code JsNoError if the operation succeeded, a failure code otherwise.
The current runtime should be in debug state. This API can only be called when runtime is at a break.
|
| JsDiagStartDebugging⚠ |
Starts debugging in the given runtime.
Runtime to put into debug mode.
Registers a callback to be called on every JsDiagDebugEvent.
User provided state that will be passed back to the callback.
The code JsNoError if the operation succeeded, a failure code otherwise.
The runtime should be active on the current thread and should not be in debug state.
|
| JsDiagStopDebugging⚠ |
Stops debugging in the given runtime.
Runtime to stop debugging.
User provided state that was passed in JsDiagStartDebugging.
The code JsNoError if the operation succeeded, a failure code otherwise.
The runtime should be active on the current thread and in debug state.
|
| JsDisableRuntimeExecution⚠ |
Suspends script execution and terminates any running scripts in a runtime.
Calls to a suspended runtime will fail until JsEnableRuntimeExecution is called.
This API does not have to be called on the thread the runtime is active on. Although the
runtime will be set into a suspended state, an executing script may not be suspended
immediately; a running script will be terminated with an uncatchable exception as soon as
possible.
Suspending execution in a runtime that is already suspended is a no-op.
The runtime to be suspended.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsDisposeRuntime⚠ |
Disposes a runtime.
Once a runtime has been disposed, all resources owned by it are invalid and cannot be used.
If the runtime is active (i.e. it is set to be current on a particular thread), it cannot
be disposed.
The runtime to dispose.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsDoubleToNumber⚠ |
Creates a number value from a double value.
Requires an active script context.
The double to convert to a number value.
The new number value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsEnableRuntimeExecution⚠ |
Enables script execution in a runtime.
Enabling script execution in a runtime that already has script execution enabled is a
no-op.
The runtime to be enabled.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsEquals⚠ |
Compare two JavaScript values for equality.
This function is equivalent to the == operator in Javascript.
Requires an active script context.
The first object to compare.
The second object to compare.
Whether the values are equal.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetAndClearException⚠ |
Returns the exception that caused the runtime of the current context to be in the
exception state and resets the exception state for that runtime.
If the runtime of the current context is not in an exception state, this API will return
JsErrorInvalidArgument. If the runtime is disabled, this will return an exception
indicating that the script was terminated, but it will not clear the exception (the
exception will be cleared if the runtime is re-enabled using
JsEnableRuntimeExecution).
Requires an active script context.
The exception for the runtime of the current context.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetAndClearExceptionWithMetadata⚠ |
Returns metadata relating to the exception that caused the runtime of the current context
to be in the exception state and resets the exception state for that runtime. The metadata
includes a reference to the exception itself.
If the runtime of the current context is not in an exception state, this API will return
JsErrorInvalidArgument. If the runtime is disabled, this will return an exception
indicating that the script was terminated, but it will not clear the exception (the
exception will be cleared if the runtime is re-enabled using
JsEnableRuntimeExecution).
The metadata value is a javascript object with the following properties: exception, the
thrown exception object; line, the 0 indexed line number where the exception was thrown;
column, the 0 indexed column number where the exception was thrown; length, the
source-length of the cause of the exception; source, a string containing the line of
source code where the exception was thrown; and url, a string containing the name of
the script file containing the code that threw the exception.
Requires an active script context.
The exception metadata for the runtime of the current context.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetArrayBufferStorage⚠ |
Obtains the underlying memory storage used by an ArrayBuffer.
The ArrayBuffer instance.
The ArrayBuffer's buffer. The lifetime of the buffer returned is the same as the lifetime of the
the ArrayBuffer. The buffer pointer does not count as a reference to the ArrayBuffer for the purpose
of garbage collection.
The number of bytes in the buffer.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetContextData⚠ |
Gets the internal data set on JsrtContext.
The context to get the data from.
The pointer to the data where data will be returned.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetContextOfObject⚠ |
Gets the script context that the object belongs to.
The object to get the context from.
The context the object belongs to.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetCurrentContext⚠ |
Gets the current script context on the thread.
The current script context on the thread, null if there is no current script context.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetDataViewStorage⚠ |
Obtains the underlying memory storage used by a DataView.
The DataView instance.
The DataView's buffer. The lifetime of the buffer returned is the same as the lifetime of the
the DataView. The buffer pointer does not count as a reference to the DataView for the purpose
of garbage collection.
The number of bytes in the buffer.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetExtensionAllowed⚠ |
Returns a value that indicates whether an object is extensible or not.
Requires an active script context.
The object to test.
Whether the object is extensible or not.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetExternalData⚠ |
Retrieves the data from an external object.
The external object.
The external data stored in the object. Can be null if no external data is stored in the
object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetFalseValue⚠ |
Gets the value of false in the current script context.
Requires an active script context.
The false value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetGlobalObject⚠ |
Gets the global object in the current script context.
Requires an active script context.
The global object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetIndexedPropertiesExternalData⚠ |
Retrieves an object's indexed properties external data information.
The object.
The external data back store for the object's indexed properties.
The array element type in external data.
The number of array elements in external data.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetIndexedProperty⚠ |
Retrieve the value at the specified index of an object.
Requires an active script context.
The object to operate on.
The index to retrieve.
The retrieved value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetModuleHostInfo⚠ |
Retrieve the host info for the specified module.
The request module.
The type of host info to get.
The host info to be retrieved.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetNullValue⚠ |
Gets the value of null in the current script context.
Requires an active script context.
The null value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetOwnPropertyDescriptor⚠ |
Gets a property descriptor for an object's own property.
Requires an active script context.
The object that has the property.
The ID of the property.
The property descriptor.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetOwnPropertyNames⚠ |
Gets the list of all properties on the object.
Requires an active script context.
The object from which to get the property names.
An array of property names.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetOwnPropertySymbols⚠ |
Gets the list of all symbol properties on the object.
Requires an active script context.
The object from which to get the property symbols.
An array of property symbols.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetProperty⚠ |
Gets an object's property.
Requires an active script context.
The object that contains the property.
The ID of the property.
The value of the property.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetPropertyIdFromSymbol⚠ |
Gets the property ID associated with the symbol.
Property IDs are specific to a context and cannot be used across contexts.
Requires an active script context.
The symbol whose property ID is being retrieved.
The property ID for the given symbol.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetPropertyIdType⚠ |
Gets the type of property
Requires an active script context.
The property ID to get the type of.
The JsPropertyIdType of the given property ID
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetPrototype⚠ |
Returns the prototype of an object.
Requires an active script context.
The object whose prototype is to be returned.
The object's prototype.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetRuntime⚠ |
Gets the runtime that the context belongs to.
The context to get the runtime from.
The runtime the context belongs to.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetRuntimeMemoryLimit⚠ |
Gets the current memory limit for a runtime.
The memory limit of a runtime can be always be retrieved, regardless of whether or not the
runtime is active on another thread.
The runtime whose memory limit is to be retrieved.
The runtime's current memory limit, in bytes, or -1 if no limit has been set.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetRuntimeMemoryUsage⚠ |
Gets the current memory usage for a runtime.
Memory usage can be always be retrieved, regardless of whether or not the runtime is active
on another thread.
The runtime whose memory usage is to be retrieved.
The runtime's current memory usage, in bytes.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetStringLength⚠ |
Gets the length of a string value.
The string value to get the length of.
The length of the string.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetSymbolFromPropertyId⚠ |
Gets the symbol associated with the property ID.
Requires an active script context.
The property ID to get the symbol of.
The symbol associated with the property ID.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetTrueValue⚠ |
Gets the value of true in the current script context.
Requires an active script context.
The true value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetTypedArrayInfo⚠ |
Obtains frequently used properties of a typed array.
The typed array instance.
The type of the array.
The ArrayBuffer backstore of the array.
The offset in bytes from the start of arrayBuffer referenced by the array.
The number of bytes in the array.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetTypedArrayStorage⚠ |
Obtains the underlying memory storage used by a typed array.
The typed array instance.
The array's buffer. The lifetime of the buffer returned is the same as the lifetime of the
the array. The buffer pointer does not count as a reference to the array for the purpose
of garbage collection.
The number of bytes in the buffer.
The type of the array.
The size of an element of the array.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetUndefinedValue⚠ |
Gets the value of undefined in the current script context.
Requires an active script context.
The undefined value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetValueType⚠ |
Gets the JavaScript type of a JsValueRef.
The value whose type is to be returned.
The type of the value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsGetWeakReferenceValue⚠ |
Gets a strong reference to the value referred to by a weak reference.
A weak reference.
Reference to the value, or JS_INVALID_REFERENCE if the value is
no longer available.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsHasException⚠ |
Determines whether the runtime of the current context is in an exception state.
If a call into the runtime results in an exception (either as the result of running a
script or due to something like a conversion failure), the runtime is placed into an
"exception state." All calls into any context created by the runtime (except for the
exception APIs) will fail with JsErrorInExceptionState until the exception is
cleared.
If the runtime of the current context is in the exception state when a callback returns
into the engine, the engine will automatically rethrow the exception.
Requires an active script context.
Whether the runtime of the current context is in the exception state.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsHasExternalData⚠ |
Determines whether an object is an external object.
The object.
Whether the object is an external object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsHasIndexedPropertiesExternalData⚠ |
Determines whether an object has its indexed properties in external data.
The object.
Whether the object has its indexed properties in external data.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsHasIndexedProperty⚠ |
Tests whether an object has a value at the specified index.
Requires an active script context.
The object to operate on.
The index to test.
Whether the object has a value at the specified index.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsHasProperty⚠ |
Determines whether an object has a property.
Requires an active script context.
The object that may contain the property.
The ID of the property.
Whether the object (or a prototype) has the property.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsIdle⚠ |
Tells the runtime to do any idle processing it need to do.
If idle processing has been enabled for the current runtime, calling JsIdle will
inform the current runtime that the host is idle and that the runtime can perform
memory cleanup tasks.
JsIdle can also return the number of system ticks until there will be more idle work
for the runtime to do. Calling JsIdle before this number of ticks has passed will do
no work.
Requires an active script context.
The next system tick when there will be more idle work to do. Can be null. Returns the
maximum number of ticks if there no upcoming idle work to do.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsInitializeModuleRecord⚠ |
Initialize a ModuleRecord from host
Bootstrap the module loading process by creating a new module record.
The referencingModule as in HostResolveImportedModule (15.2.1.17). nullptr if this is the top level module.
The host normalized specifier. This is the key to a unique ModuleRecord.
The new ModuleRecord created. The host should not try to call this API twice with the same normalizedSpecifier.
chakra will return an existing ModuleRecord if the specifier was passed in before.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsInstanceOf⚠ |
Performs JavaScript "instanceof" operator test.
Requires an active script context.
The object to test.
The constructor function to test against.
Whether "object instanceof constructor" is true.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsIntToNumber⚠ |
Creates a number value from an int value.
Requires an active script context.
The int to convert to a number value.
The new number value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsIsRuntimeExecutionDisabled⚠ |
Returns a value that indicates whether script execution is disabled in the runtime.
Specifies the runtime to check if execution is disabled.
If execution is disabled, true, false otherwise.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsModuleEvaluation⚠ |
Execute module code.
This method implements 15.2.1.1.6.5, "ModuleEvaluation" concrete method.
When this methid is called, the chakra engine should have notified the host that the module and all its dependent are ready to be executed.
One moduleRecord will be executed only once. Additional execution call on the same moduleRecord will fail.
The module to be executed.
The return value of the module.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsNumberToDouble⚠ |
Retrieves the double value of a number value.
This function retrieves the value of a number value. It will fail with
JsErrorInvalidArgument if the type of the value is not number.
The number value to convert to a double value.
The double value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsNumberToInt⚠ |
Retrieves the int value of a number value.
This function retrieves the value of a number value and converts to an int value.
It will fail with JsErrorInvalidArgument if the type of the value is not number.
The number value to convert to an int value.
The int value.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsParse⚠ |
Parses a script and returns a function representing the script.
Requires an active script context.
Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
for better performance and smaller memory footprint.
The script to run.
A cookie identifying the script that can be used by debuggable script contexts.
The location the script came from.
Attribute mask for parsing the script
The result of the compiled script.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsParseModuleSource⚠ |
Parse the module source
This is basically ParseModule operation in ES6 spec. It is slightly different in that the ModuleRecord was initialized earlier, and passed in as an argument.
The ModuleRecord that holds the parse tree of the source code.
A cookie identifying the script that can be used by debuggable script contexts.
The source script to be parsed, but not executed in this code.
The source length of sourceText. The input might contain embedded null.
The type of the source code passed in. It could be UNICODE or utf8 at this time.
The error object if there is parse error.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsParseSerialized⚠ |
Parses a serialized script and returns a function representing the script.
Provides the ability to lazy load the script source only if/when it is needed.
Requires an active script context.
The serialized script as an ArrayBuffer (preferably ExternalArrayBuffer).
Callback called when the source code of the script needs to be loaded.
This is an optional parameter, set to null if not needed.
A cookie identifying the script that can be used by debuggable script contexts.
This context will passed into scriptLoadCallback.
The location the script came from.
A function representing the script code.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsPreventExtension⚠ |
Makes an object non-extensible.
Requires an active script context.
The object to make non-extensible.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsRelease⚠ |
Releases a reference to a garbage collected object.
Removes a reference to a JsRef handle that was created by JsAddRef.
The object to add a reference to.
The object's new reference count (can pass in null).
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsRun⚠ |
Executes a script.
Requires an active script context.
Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
for better performance and smaller memory footprint.
The script to run.
A cookie identifying the script that can be used by debuggable script contexts.
The location the script came from
Attribute mask for parsing the script
The result of the script, if any. This parameter can be null.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsRunSerialized⚠ |
Runs a serialized script.
Provides the ability to lazy load the script source only if/when it is needed.
Requires an active script context.
The runtime will hold on to the buffer until all instances of any functions created from
the buffer are garbage collected.
The serialized script as an ArrayBuffer (preferably ExternalArrayBuffer).
Callback called when the source code of the script needs to be loaded.
A cookie identifying the script that can be used by debuggable script contexts.
This context will passed into scriptLoadCallback.
The location the script came from.
The result of running the script, if any. This parameter can be null.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSerialize⚠ |
Serializes a parsed script to a buffer than can be reused.
JsSerializeScript parses a script and then stores the parsed form of the script in a
runtime-independent format. The serialized script then can be deserialized in any
runtime without requiring the script to be re-parsed.
Requires an active script context.
Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
for better performance and smaller memory footprint.
The script to serialize
ArrayBuffer
Encoding for the script.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetContextData⚠ |
Sets the internal data of JsrtContext.
The context to set the data to.
The pointer to the data to be set.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetCurrentContext⚠ |
Sets the current script context on the thread.
The script context to make current.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetException⚠ |
Sets the runtime of the current context to an exception state.
If the runtime of the current context is already in an exception state, this API will
return JsErrorInExceptionState.
Requires an active script context.
The JavaScript exception to set for the runtime of the current context.
JsNoError if the engine was set into an exception state, a failure code otherwise.
|
| JsSetExternalData⚠ |
Sets the external data on an external object.
The external object.
The external data to be stored in the object. Can be null if no external data is
to be stored in the object.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetIndexedPropertiesToExternalData⚠ |
Sets an object's indexed properties to external data. The external data will be used as back
store for the object's indexed properties and accessed like a typed array.
Requires an active script context.
The object to operate on.
The external data to be used as back store for the object's indexed properties.
The array element type in external data.
The number of array elements in external data.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetIndexedProperty⚠ |
Set the value at the specified index of an object.
Requires an active script context.
The object to operate on.
The index to set.
The value to set.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetModuleHostInfo⚠ |
Set the host info for the specified module.
The request module.
The type of host info to be set.
The host info to be set.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetObjectBeforeCollectCallback⚠ |
Sets a callback function that is called by the runtime before garbage collection of
an object.
The callback is invoked on the current runtime execution thread, therefore execution is
blocked until the callback completes.
The object for which to register the callback.
User provided state that will be passed back to the callback.
The callback function being set. Use null to clear
previously registered callback.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetPromiseContinuationCallback⚠ |
Sets a promise continuation callback function that is called by the context when a task
needs to be queued for future execution
Requires an active script context.
The callback function being set.
User provided state that will be passed back to the callback.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetProperty⚠ |
Puts an object's property.
Requires an active script context.
The object that contains the property.
The ID of the property.
The new value of the property.
The property set should follow strict mode rules.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetPrototype⚠ |
Sets the prototype of an object.
Requires an active script context.
The object whose prototype is to be changed.
The object's new prototype.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetRuntimeBeforeCollectCallback⚠ |
Sets a callback function that is called by the runtime before garbage collection.
The callback is invoked on the current runtime execution thread, therefore execution is
blocked until the callback completes.
The callback can be used by hosts to prepare for garbage collection. For example, by
releasing unnecessary references on Chakra objects.
The runtime for which to register the allocation callback.
User provided state that will be passed back to the callback.
The callback function being set.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetRuntimeMemoryAllocationCallback⚠ |
Sets a memory allocation callback for specified runtime
Registering a memory allocation callback will cause the runtime to call back to the host
whenever it acquires memory from, or releases memory to, the OS. The callback routine is
called before the runtime memory manager allocates a block of memory. The allocation will
be rejected if the callback returns false. The runtime memory manager will also invoke the
callback routine after freeing a block of memory, as well as after allocation failures.
The callback is invoked on the current runtime execution thread, therefore execution is
blocked until the callback completes.
The return value of the callback is not stored; previously rejected allocations will not
prevent the runtime from invoking the callback again later for new memory allocations.
The runtime for which to register the allocation callback.
User provided state that will be passed back to the callback.
Memory allocation callback to be called for memory allocation events.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsSetRuntimeMemoryLimit⚠ |
Sets the current memory limit for a runtime.
A memory limit will cause any operation which exceeds the limit to fail with an "out of
memory" error. Setting a runtime's memory limit to -1 means that the runtime has no memory
limit. New runtimes default to having no memory limit. If the new memory limit exceeds
current usage, the call will succeed and any future allocations in this runtime will fail
until the runtime's memory usage drops below the limit.
A runtime's memory limit can be always be set, regardless of whether or not the runtime is
active on another thread.
The runtime whose memory limit is to be set.
The new runtime memory limit, in bytes, or -1 for no memory limit.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsStrictEquals⚠ |
Compare two JavaScript values for strict equality.
This function is equivalent to the === operator in Javascript.
Requires an active script context.
The first object to compare.
The second object to compare.
Whether the values are strictly equal.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDCheckAndAssertIfTTDRunning⚠ |
TTD API -- may change in future versions:
A check for unimplmented TTD actions in the host.
This API is a TEMPORARY API while we complete the implementation of TTD support in the Node host and will be deleted once that is complete.
The message to print if we should be catching this as a TTD operation.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDCreateContext⚠ |
TTD API -- may change in future versions:
Creates a script context that takes the TTD mode from the log or explicitly is not in TTD mode (regular takes mode from currently active script).
The runtime the script context is being created in.
Set to true to use runtime TTD mode false to explicitly be non-TTD context.
The created script context.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDCreateRecordRuntime⚠ |
TTD API -- may change in future versions:
Creates a new runtime in Record Mode.
The attributes of the runtime to be created.
The interval to wait between snapshots (measured in millis).
The amount of history to maintain before discarding -- measured in number of snapshots and controls how far back in time a trace can be reversed.
The TTDOpenResourceStreamCallback function for generating a JsTTDStreamHandle to read/write serialized data.
The JsTTDWriteBytesToStreamCallback function for writing bytes to a JsTTDStreamHandle.
The JsTTDFlushAndCloseStreamCallback function for flushing and closing a JsTTDStreamHandle as needed.
The thread service for the runtime. Can be null.
The runtime created.
See JsCreateRuntime for additional information.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDCreateReplayRuntime⚠ |
TTD API -- may change in future versions:
Creates a new runtime in Debug Mode.
The attributes of the runtime to be created.
The uri where the recorded Time-Travel data should be loaded from.
A flag to enable addtional debugging operation support during replay.
The TTDOpenResourceStreamCallback function for generating a JsTTDStreamHandle to read/write serialized data.
The JsTTDReadBytesFromStreamCallback function for reading bytes from a JsTTDStreamHandle.
The JsTTDFlushAndCloseStreamCallback function for flushing and closing a JsTTDStreamHandle as needed.
The thread service for the runtime. Can be null.
The runtime created.
See JsCreateRuntime for additional information.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDGetPreviousSnapshotInterval⚠ |
TTD API -- may change in future versions:
Get the snapshot interval that precedes the one given by currentSnapStartTime (or -1 if there is no such interval).
The runtime handle that the script is executing in.
The current snapshot interval start time.
The resulting previous snapshot interval start time or -1 if no such time.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDGetSnapShotBoundInterval⚠ |
TTD API -- may change in future versions:
Get the snapshot interval that bounds the target event time.
The runtime handle that the script is executing in.
The event time we want to get the interval for.
The snapshot time that comes before the desired event.
The snapshot time that comes after the desired event (-1 if the leg ends before a snapshot appears).
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDGetSnapTimeTopLevelEventMove⚠ |
TTD API -- may change in future versions:
Before calling JsTTDMoveToTopLevelEvent (which inflates a snapshot and replays) check to see if we want to reset the script context.
We reset the script context if the move will require inflating from a different snapshot that the last one.
The runtime handle that the script is executing in.
Flags controlling the way the move it performed and how other parameters are interpreted.
When moveMode == JsTTDMoveKthEvent indicates which event, otherwise this parameter is ignored.
The event time we want to move to or -1 if not relevant.
Out parameter with the event time of the snapshot that we should inflate from.
Optional Out parameter with the snapshot time following the event.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDHostExit⚠ |
TTD API -- may change in future versions:
Notify the Js runtime the host is aborting the process and what the status code is.
The exit status code.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDMoveToTopLevelEvent⚠ |
TTD API -- may change in future versions:
Move to the given top-level call event time (assuming JsTTDPrepContextsForTopLevelEventMove) was called previously to reset any script contexts.
This also computes the ready-to-run snapshot if needed.
The runtime handle that the script is executing in.
Additional flags for controling how the move is done.
The event time that we will start executing from to move to the given target time.
The event that we want to move to.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDNotifyContextDestroy⚠ |
TTD API -- may change in future versions:
Notify the time-travel system that a context has been identified as dead by the gc (and is being de-allocated).
The script context that is now dead.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDNotifyLongLivedReferenceAdd⚠ |
TTD API -- may change in future versions:
Notify the TTD runtime that we are doing a weak add on a reference (we may use this in external API calls and the release will happen in a GC callback).
The value we are adding the ref to.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDNotifyYield⚠ |
TTD API -- may change in future versions:
Notify the Js runtime we are at a safe yield point in the event loop (i.e. no locals on the stack and we can proccess as desired).
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDPauseTimeTravelBeforeRuntimeOperation⚠ |
TTD API -- may change in future versions:
Pause Time-Travel recording before executing code on behalf of debugger or other diagnostic/telemetry.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDPreExecuteSnapShotInterval⚠ |
Additional flags for controling how the move is done.
The updated target event time set according to the moveMode (-1 if not found).
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDRawBufferAsyncModificationRegister⚠ |
TTD API -- may change in future versions:
Get info for notifying the TTD system that a raw buffer it shares with the host has been modified.
The array buffer we want to monitor for contents modification.
The first position in the buffer that may be modified.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDRawBufferAsyncModifyComplete⚠ |
TTD API -- may change in future versions:
Notify the event log that the contents of a naked byte* buffer passed to the host have been modified asynchronously.
One past the last modified position in the buffer.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDRawBufferCopySyncIndirect⚠ |
TTD API -- may change in future versions:
Notify the event log that the contents of one buffer have been copied to a second buffer.
The buffer that was written into.
The first index modified.
The buffer that was copied from.
The first index copied.
The number of bytes copied.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDRawBufferModifySyncIndirect⚠ |
TTD API -- may change in future versions:
Notify the event log that the contents of a naked byte* buffer passed to the host have been modified synchronously.
The buffer that was modified.
The first index modified.
The number of bytes written.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDReStartTimeTravelAfterRuntimeOperation⚠ |
TTD API -- may change in future versions:
ReStart Time-Travel recording after executing code on behalf of debugger or other diagnostic/telemetry.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDReplayExecution⚠ |
TTD API -- may change in future versions:
Execute from the current point in the log to the end returning the error code.
Additional flags for controling how the move is done.
The event time that we should move to next or notification (-1) that replay has ended.
If the debugger requested an abort the code is JsNoError -- rootEventTime is the target event time we need to move to and re - execute from.
If we aborted at the end of the replay log the code is JsNoError -- rootEventTime is -1.
If there was an unhandled script exception the code is JsErrorCategoryScript.
|
| JsTTDStart⚠ |
TTD API -- may change in future versions:
Start Time-Travel record or replay at next turn of event loop.
The code JsNoError if the operation succeeded, a failure code otherwise.
|
| JsTTDStop⚠ |
TTD API -- may change in future versions:
Stop Time-Travel record or replay.
The code JsNoError if the operation succeeded, a failure code otherwise.
|