(JavaScript) Call a JavaScript Function Passing an Array Argument

See more JavaScript Examples

Note: This example requires Chilkat v11.4.0 or greater.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This is the JavaScript function we'll call:

// function calculateTotal(numbers) {
//   console.log(numbers);
//   let total = 0;
//   
//   // Loop through every number in the array
//   for (const num of numbers) {
//     console.log(num);
//     total += num;
//   }
//   
//   return total;
// }

var sbScript = new CkStringBuilder();
success = sbScript.LoadFile("js_function_array_arg.js","utf-8");
if (success == false) {
    console.log(sbScript.LastErrorText);
    return;
}

var js = new CkJs();

var result = new CkJsonObject();
result.EmitCompact = false;

// Call Eval to add the function to the context's global object
success = js.Eval(sbScript,result);
if (success == false) {
    // Examine the result for an exception.
    console.log(result.Emit());

    // Also examine the LastErrorText.
    console.log(js.LastErrorText);
    return;
}

// ------------------------------------------------------------------------------
// Call the function calculateTotal(numbers)

var funcCall = new CkJsonObject();
funcCall.EmitCompact = false;

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

funcCall.UpdateString("name","calculateTotal");

// Create the arguments array.
var argsArray = new CkJsonArray();

// The 1st argument in the arguments array is itself an array.
// Passing -1 indicates to append to the array.
var arg = new CkJsonArray();
argsArray.AddArrayAt2(-1,arg);

// Fill in the values for the 1st argument.
arg.AddNumberAt(-1,"10.50");
arg.AddNumberAt(-1,"20.00");
arg.AddNumberAt(-1,"5.25");

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

console.log(funcCall.Emit());

// The funcCall is as follows.  Notice that the 1st (and only) argument is an array.

// {
//   "name": "calculateTotal",
//   "args": [
//     [
//       10.50,
//       20.00,
//       5.25
//     ]
//   ]
// }

success = js.CallFunction(funcCall,result);
if (success == false) {
    // Examine the result for an exception.
    console.log(result.Emit());

    // Also examine the LastErrorText.
    console.log(js.LastErrorText);
    return;
}

console.log(result.Emit());

// Result:
// {
//   "type": "double",
//   "value": 35.75
// }

// The function also emitted text to the console.

var sbOut = new CkStringBuilder();
js.ConsoleOutputSb(sbOut);
console.log(sbOut.GetAsString());

// Output:
// 10.5,20,5.25
// 10.5
// 20
// 5.25

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

funcCall.Clear();
funcCall.UpdateString("name","calculateTotal");
funcCall.UpdateNumber("args[0][0]","10.50");
funcCall.UpdateNumber("args[0][1]","20.00");
funcCall.UpdateNumber("args[0][2]","5.25");
console.log(funcCall.Emit());