JavaScript

Call a JavaScript Function Returning an Array

See more JavaScript Examples

Demonstrates how to call a JavaScript function that returns an array. JavaScript

var success = false;

//  ----------------------------------------------------------------------------------
//  The Javascript functions called in this example are shown at the bottom of this page.
//  -----------------------------------------------------------------------------------

var sbScript = new CkStringBuilder();
success = sbScript.LoadFile("js_function_returning_array.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 each function

var funcCall = new CkJsonObject();

//  Create JSON specifying the function name and arguments
//  The function has no arguments, so we only specify the name.

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

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());

//  Output:
//  {
//    "type": "array",
//    "value": [
//      "Monday",
//      "Tuesday",
//      "Wednesday",
//      "Thursday",
//      "Friday"
//    ]
//  }

//  Access each array value..
var count = result.SizeOfArray("value");
var i = 0;
while (i < count) {
    result.I = i;
    console.log(result.StringOf("value[i]"));
    i = i+1;
}

//  ------------------------------------------------------------------------------
//  Call the getRange(start,end) function

funcCall.Clear();
funcCall.UpdateString("name","getRange");
funcCall.UpdateInt("args[0]",14);
funcCall.UpdateInt("args[1]",21);
success = js.CallFunction(funcCall,result);
console.log(result.Emit());

//  Output:
//  {
//    "type": "array",
//    "value": [
//      14,
//      15,
//      16,
//      17,
//      18,
//      19,
//      20,
//      21
//    ]
//  }

count = result.SizeOfArray("value");
i = 0;
while (i < count) {
    result.I = i;
    console.log(result.IntOf("value[i]"));
    i = i+1;
}

//  ------------------------------------------------------------------------------
//  Call the getEmployees() function

funcCall.Clear();
funcCall.UpdateString("name","getEmployees");
success = js.CallFunction(funcCall,result);
console.log(result.Emit());

//  Output:
//  {
//    "type": "array",
//    "value": [
//      {
//        "id": 101,
//        "name": "Alice",
//        "role": "Dev"
//      },
//      {
//        "id": 102,
//        "name": "Bob",
//        "role": "Manager"
//      }
//    ]
//  }

count = result.SizeOfArray("value");
i = 0;
while (i < count) {
    result.I = i;
    console.log("name: " + result.StringOf("value[i].name"));
    console.log("role: " + result.StringOf("value[i].role"));
    console.log("id: " + result.IntOf("value[i].id"));
    console.log("");
    i = i+1;
}

JavaScript

function getDays() {
    return ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"];
}

function getRange(start, end) {
    var arr = [];
    for (var i = start; i <= end; i++) {
        arr.push(i);
    }
    return arr;
}
// Usage: getRange(1, 5) -> [1, 2, 3, 4, 5]

function getEmployees() {
    return [
        { id: 101, name: "Alice", role: "Dev" },
        { id: 102, name: "Bob", role: "Manager" }
    ];
}