Skip to content

arrayLength

Description

Returns the number of elements in an array.

Syntax

Like many functions in DataPrime, arrayLength supports two notations, function and method notation. These interchangeable forms allow flexibility in how you structure expressions.

arrayLength(array: array<any>): number
(array: array<any>).arrayLength(): number

Arguments

NameTypeRequiredDescription
arrayarraytrueThe array whose length will be calculated

Example

Use case: Determine the number of jobs waiting to be processed

Suppose you have a list of jobs in a queue. Consider the following input:

{
    "loading_jobs_waiting": ["loading_job1", "loading_job2", "loading_job3"]
}

By applying arrayLength, you can find out how many jobs are waiting.

create waiting_jobs from arrayLength(loading_jobs_waiting)
create waiting_jobs from loading_jobs_waiting.arrayLength()

Output

The result will include the count of array elements:

{
    "loading_jobs_waiting": ["loading_job1", "loading_job2", "loading_job3"],
    "waiting_jobs": 3
}