@express-document-sdk / RestrictedItemList
Base for ItemLists that have restricted behavior on how items are added to the list, but allow items to be removed and reordered. Subclasses like ItemList may add more capabilities, however.
• T extends ListItem
• get first(): undefined | T
First item in this list, or undefined if list is empty.
undefined | T
• get last(): undefined | T
Last item in this list, or undefined if list is empty.
undefined | T
• get length(): number
Number of items in this list.
number
[iterator]()• [iterator](): Iterator<T, any, any>
Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.
Iterator<T, any, any>
• indexOf(item): number
Get index of item in list.
• item: T
number
index number, or -1 if item isn’t in this list.
• item(index): undefined | T
Returns item at the given index, or undefined if index is out of range.
• index: number
Zero-based index
undefined | T
• moveAfter(item, after): void
Move item so it is immediately after after in this list: places item at the index one higher than after.
Depending on the position in the list item originally occupied, some other items in the list may shift to higher
or lower indices as a result. No-op if both arguments are the same item.
• item: T
• after: T
void
An error if either argument is not contained in this list.
• moveBefore(item, before): void
Move item so it is immediately before before in this list: places item at the index that before used
to occupy. Depending on the position in the list item originally occupied, some other items in the list may
shift to higher or lower indices as a result. No-op if both arguments are the same item.
• item: T
• before: T
void
An error if either argument is not contained in this list.
• remove(…items): void
Remove the items from the list. The items need not be contiguous.
• …items: T[]
void
If any of the items are not in the list, or if it is illegal to remove any of the items from this parent.
• toArray(): readonly T[]
All items in the list, as a static array. Mutations that occur later are not reflected in an array returned earlier.
readonly T[]