B4X Requires Chilkat v11.4.0+

Call a JavaScript Function Passing an Object Argument

See more JavaScript Examples

Demonstrates how to call a JavaScript function with an argument that is an object. B4X

Dim success As Boolean = False

'  This is the JavaScript function we'll call:

'  function describeCar(car) {
'  	console.log(`This is a ${car.year} ${car.make} ${car.model}.`);
'  }

Dim sbScript As ChilkatStringBuilder
sbScript.Initialize
sbScript.Append("function describeCar(car) { console.log(`This is a ${car.year} ${car.make} ${car.model}.`); }")

Dim js As ChilkatJs
js.Initialize("js")

Dim result As ChilkatJsonObject
result.Initialize
result.EmitCompact = False

'  Call Eval to add the function to the context's global object
success = js.Eval(sbScript, result)
If success = False Then
    '  Examine the result for an exception.
    Log(result.Emit)

    '  Also examine the LastErrorText.
    Log(js.LastErrorText)
    Return
End If


'  ------------------------------------------------------------------------------
'  Call the function describeCar(car)

Dim funcCall As ChilkatJsonObject
funcCall.Initialize
funcCall.EmitCompact = False

'  Create JSON specifying the function name and arguments
'  In this case, there is only 1 argument, and it is an object.

'  {
'    "name": "describeCar",
'    "args": [
'      {
'        "make": "Toyota",
'        "model": "Corolla",
'        "year": 2022
'      }
'    ]
'  }

funcCall.UpdateString("name", "describeCar")

'  Create the JSON object that is the argument.
Dim arg As ChilkatJsonObject
arg.Initialize
arg.UpdateString("make", "Toyota")
arg.UpdateString("model", "Corolla")
arg.UpdateInt("year", 2022)

'  Create the arguments array.
Dim argsArray As ChilkatJsonArray
argsArray.Initialize
argsArray.AddObjectCopyAt(0, arg)

'  Add the "args" array to the funcCall.
funcCall.AppendArrayCopy("args", argsArray)

Log(funcCall.Emit)

success = js.CallFunction(funcCall, result)
If success = False Then
    '  Examine the result for an exception.
    Log(result.Emit)

    '  Also examine the LastErrorText.
    Log(js.LastErrorText)
    Return
End If


Log(result.Emit)

'  The describeCar JavaScript function returns nothing. 
'  Therefore, the result is "undefined".

'  {
'    "type": "undefined",
'    "value": "undefined"
'  }

'  However, the function emitted text to the console.

Dim sbOut As ChilkatStringBuilder
sbOut.Initialize
js.ConsoleOutputSb(sbOut)
Log(sbOut.GetAsString)

'  Output:
'  This is a 2022 Toyota Corolla.

'  -----------------------------------------------------------
'  Note: If the object argument is simple, this is an alternative
'  and simpler way of creating the funcCall:

funcCall.Clear
funcCall.UpdateString("name", "describeCar")
funcCall.UpdateString("args[0].make", "Toyota")
funcCall.UpdateString("args[0].model", "Corolla")
funcCall.UpdateInt("args[0].year", 2022)
Log(funcCall.Emit)