On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.

ReadableList

API reference for the ReadableList type.

A list that cannot be changed.

Type Parameters

M

Methods

countfunctionRequired

Gets the number of items in the list.

Returns

The number of items.

number

toArrayfunctionRequired

Converts the list to an array.

Returns

An array containing all items. The items are the same as in the list.

readonly M[]

forEachfunctionRequired

Executes a function for each item in the list.

Parameters

callbackForEachCallback<M>Required

The function to run for each item.

Parameters

itemMRequired

The current item in the list.

indexnumberRequired

The index of the current item.

Returns

void

Returns

void

filterfunctionRequired

Creates a new array with items that pass a test.

Parameters

filterFilterPredicate<M>Required

A function that tests each item. Returns true to keep the item.

Parameters

itemMRequired

The item to test.

Returns

true if the item should be included, otherwise false.

boolean

Returns

An array of items that passed the test.

readonly M[]