divkit/test_data/expression_test_data/function_signatures_array.json

{
  "signatures": [
    {
      "name": "getArrayString(array, integer) string",
      "function_name": "getArrayString",
      "doc": "Returns a string value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "string",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayNumber(array, integer) number",
      "function_name": "getArrayNumber",
      "doc": "Returns a number value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "number",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayInteger(array, integer) integer",
      "function_name": "getArrayInteger",
      "doc": "Returns an integer value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "integer",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayBoolean(array, integer) boolean",
      "function_name": "getArrayBoolean",
      "doc": "Returns a boolean property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "boolean",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayColor(array, integer) color",
      "function_name": "getArrayColor",
      "doc": "Returns a color property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "color",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptString(array, integer, string) string",
      "function_name": "getArrayOptString",
      "doc": "Returns an optional string property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "string",
          "doc": "Fallback value if value by index not exists or it's is not a string."
        }
      ],
      "result_type": "string",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptNumber(array, integer, number) number",
      "function_name": "getArrayOptNumber",
      "doc": "Returns an optional number property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "number",
          "doc": "Fallback value if value by index not exists or it's is not a number."
        }
      ],
      "result_type": "number",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptInteger(array, integer, integer) integer",
      "function_name": "getArrayOptInteger",
      "doc": "Returns an optional integer property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "integer",
          "doc": "Fallback value if property does not exist or a property value is not an integer."
        }
      ],
      "result_type": "integer",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptBoolean(array, integer, boolean) boolean",
      "function_name": "getArrayOptBoolean",
      "doc": "Returns an optional boolean value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "boolean",
          "doc": "Fallback value if value by index not exists or it's is not a boolean."
        }
      ],
      "result_type": "boolean",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptColor(array, integer, color) color",
      "function_name": "getArrayOptColor",
      "doc": "Returns an optional color value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "color",
          "doc": "Fallback value if value by index not exists or it's is not a color."
        }
      ],
      "result_type": "color",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptColor(array, integer, string) color",
      "function_name": "getArrayOptColor",
      "doc": "Returns an optional color value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "string",
          "doc": "Fallback value if value by index not exists or it's is not a color."
        }
      ],
      "result_type": "color",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayUrl(array, integer) url",
      "function_name": "getArrayUrl",
      "doc": "Returns an url value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "url",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptUrl(array, integer, url) url",
      "function_name": "getArrayOptUrl",
      "doc": "Returns an optional url value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "url",
          "doc": "Fallback value if value by index not exists or it's is not a url."
        }
      ],
      "result_type": "url",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayOptUrl(array, integer, string) url",
      "function_name": "getArrayOptUrl",
      "doc": "Returns an optional url value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "string",
          "doc": "Fallback value if value by index not exists or it's is not a url."
        }
      ],
      "result_type": "url",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getStringFromArray(array, integer) string",
      "function_name": "getStringFromArray",
      "doc": "Returns a string value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "string",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getNumberFromArray(array, integer) number",
      "function_name": "getNumberFromArray",
      "doc": "Returns a number value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "number",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getIntegerFromArray(array, integer) integer",
      "function_name": "getIntegerFromArray",
      "doc": "Returns an integer value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "integer",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getBooleanFromArray(array, integer) boolean",
      "function_name": "getBooleanFromArray",
      "doc": "Returns a boolean property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "boolean",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getColorFromArray(array, integer) color",
      "function_name": "getColorFromArray",
      "doc": "Returns a color property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "color",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptStringFromArray(array, integer, string) string",
      "function_name": "getOptStringFromArray",
      "doc": "Returns an optional string property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "string",
          "doc": "Fallback value if value by index not exists or it's is not a string."
        }
      ],
      "result_type": "string",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptNumberFromArray(array, integer, number) number",
      "function_name": "getOptNumberFromArray",
      "doc": "Returns an optional number property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "number",
          "doc": "Fallback value if value by index not exists or it's is not a number."
        }
      ],
      "result_type": "number",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptIntegerFromArray(array, integer, integer) integer",
      "function_name": "getOptIntegerFromArray",
      "doc": "Returns an optional integer property from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "integer",
          "doc": "Fallback value if property does not exist or a property value is not an integer."
        }
      ],
      "result_type": "integer",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptBooleanFromArray(array, integer, boolean) boolean",
      "function_name": "getOptBooleanFromArray",
      "doc": "Returns an optional boolean value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "boolean",
          "doc": "Fallback value if value by index not exists or it's is not a boolean."
        }
      ],
      "result_type": "boolean",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptColorFromArray(array, integer, color) color",
      "function_name": "getOptColorFromArray",
      "doc": "Returns an optional color value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "color",
          "doc": "Fallback value if value by index not exists or it's is not a color."
        }
      ],
      "result_type": "color",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptColorFromArray(array, integer, string) color",
      "function_name": "getOptColorFromArray",
      "doc": "Returns an optional color value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "string",
          "doc": "Fallback value if value by index not exists or it's is not a color."
        }
      ],
      "result_type": "color",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getUrlFromArray(array, integer) url",
      "function_name": "getUrlFromArray",
      "doc": "Returns an url value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "url",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptUrlFromArray(array, integer, url) url",
      "function_name": "getOptUrlFromArray",
      "doc": "Returns an optional url value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "url",
          "doc": "Fallback value if value by index not exists or it's is not a url."
        }
      ],
      "result_type": "url",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptUrlFromArray(array, integer, string) url",
      "function_name": "getOptUrlFromArray",
      "doc": "Returns an optional url value from array.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        },
        {
          "type": "string",
          "doc": "Fallback value if value by index not exists or it's is not a url."
        }
      ],
      "result_type": "url",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getArrayFromArray(array, integer) array",
      "function_name": "getArrayFromArray",
      "doc": "Returns an array value from array",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "array",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptArrayFromArray(array, integer) array",
      "function_name": "getOptArrayFromArray",
      "doc": "Returns an array value from array if exist or empty array otherwise",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "array",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getDictFromArray(array, integer) dict",
      "function_name": "getDictFromArray",
      "doc": "Returns an dict value from array",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "dict",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "getOptDictFromArray(array, integer) dict",
      "function_name": "getOptDictFromArray",
      "doc": "Returns an dict value from array if exist or empty dict otherwise",
      "arguments": [
        {
          "type": "array",
          "doc": "Array."
        },
        {
          "type": "integer",
          "doc": "Index at array."
        }
      ],
      "result_type": "dict",
      "platforms": [
        "android",
        "ios",
        "web"
      ]
    },
    {
      "name": "len(array) integer",
      "function_name": "len",
      "doc": "Gets the length of array. Returns integer value.",
      "arguments": [
        {
          "type": "array",
          "doc": "Array value to get length of."
        }
      ],
      "result_type": "integer",
      "platforms": [
        "web",
        "android",
        "ios"
      ]
    }
  ]
}