Class ItemList<T>

The ItemList class collects items and then arranges them into an array by priority.

Type Parameters

Index

Constructors

constructor

new ItemList<T>(): ItemList<T>
Type Parameters
- T
Returns ItemList<T>

Properties

`Protected`_items

_items: Record<string, Item<T>> = {}

The items in the list.

Methods

add

add(key: string, content: T, priority?: number): this
Add an item to the list.
Parameters
- key: string
  A unique key for the item.
- content: T
  The item's content.
- priority: number = 0
  The priority of the item. Items with a higher priority will be positioned before items with a lower priority.
Returns this
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:65

get

get(key: string): T
Get the content of an item.
Parameters
- key: string
Returns T
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:46

getPriority

getPriority(key: string): number
Get the priority of an item.
Parameters
- key: string
Returns number
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:53

has

has(key: string): boolean
Check whether an item is present in the list.
Parameters
- key: string
Returns boolean
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:39

isEmpty

isEmpty(): boolean
Check whether the list is empty.

Returns boolean
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:32

merge

merge(otherList: ItemList<T>): ItemList<T>
Merge another list's items into this one.

The list passed to this function will overwrite items which already exist with the same key.
Parameters
- otherList: ItemList<T>
Returns ItemList<T>
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:146

remove

remove(key: string): this
Remove an item from the list.

If the provided key is not present, nothing will happen.
Parameters
- key: string
Returns this
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:134

setContent

setContent(key: string, content: T): this
Replaces an item's content, if the provided item key exists.

If the provided key is not present, an error will be thrown.
Parameters
- key: string
 The key of the item in the list
- content: T
 The item's new content
Returns this
Example: Replace item content.
```
items.setContent('myItem', My new value.);
```
Example: Replace item content and priority.
```
 items
 .setContent('myItem', My new value.)
 .setPriority('myItem', 10);
```
Throws
If the provided key is not present in the ItemList.
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:89

setPriority

setPriority(key: string, priority: number): this
Replaces an item's priority, if the provided item key exists.

If the provided key is not present, an error will be thrown.
Parameters
- key: string
 The key of the item in the list
- priority: number
 The item's new priority
Returns this
Example: Replace item priority.
```
items.setPriority('myItem', 10);
```
Example: Replace item priority and content.
```
 items
 .setPriority('myItem', 10)
 .setContent('myItem', My new value.);
```
Throws
If the provided key is not present in the ItemList.
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:119

toArray

toArray(keepPrimitives?: false): (T & { itemName: string })[]
Convert the list into an array of item content arranged by priority.

This does not preserve the original types of primitives and proxies all content values to make itemName accessible on them.

NOTE: If your ItemList holds primitive types (such as numbers, booleans or strings), these will be converted to their object counterparts if you do not provide true to this function.

NOTE: Modifying any objects in the final array may also update the content of the original ItemList.
Parameters
- OptionalkeepPrimitives: false
  Converts item content to objects and sets the itemName property on them.
Returns (T & { itemName: string })[]
See
https://github.com/flarum/core/issues/3030
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:176
toArray(
keepPrimitives: true,
): (T extends object ? T & Readonly<{ itemName: string }> : T)[]
Convert the list into an array of item content arranged by priority.

Content values that are already objects will be proxied and have itemName accessible on them. Primitive values will not have the itemName property accessible.

NOTE: Modifying any objects in the final array may also update the content of the original ItemList.
Parameters
- keepPrimitives: true
 Converts item content to objects and sets the itemName property on them.
Returns (T extends object ? T & Readonly<{ itemName: string }> : T)[]
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:190

toObject

toObject(): DeepReadonly<Record<string, IItemObject<T>>>
A read-only map of all keys to their respective items in no particular order.

We don't allow adding new items to the ItemList via setting new properties, nor do we allow modifying existing items directly. You should use the ItemList.add, ItemList.setContent and ItemList.setPriority methods instead.

To match the old behaviour of the ItemList.items property, call Object.values(ItemList.toObject()).

Returns DeepReadonly<Record<string, IItemObject<T>>>
Example
```
const items = new ItemList();
items.add('b', 'My cool value', 20);
items.add('a', 'My value', 10);
items.toObject();
// {
// a: { content: 'My value', priority: 10, itemName: 'a' },
// b: { content: 'My cool value', priority: 20, itemName: 'b' },
// }
```
- Defined in flarum/framework/core/js/src/common/utils/ItemList.ts:232

Class ItemList<T>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns ItemList<T>

Properties

Protected_items

Methods

add

Parameters

Returns this

get

Parameters

Returns T

getPriority

Parameters

Returns number

has

Parameters

Returns boolean

isEmpty

Returns boolean

merge

Parameters

Returns ItemList<T>

remove

Parameters

Returns this

setContent

Parameters

Returns this

Example: Replace item content.

Example: Replace item content and priority.

Throws

setPriority

Parameters

Returns this

Example: Replace item priority.

Example: Replace item priority and content.

Throws

toArray

Parameters

Returns (T & { itemName: string })[]

See

Parameters

Returns (T extends object ? T & Readonly<{ itemName: string }> : T)[]

toObject

Returns DeepReadonly<Record<string, IItemObject<T>>>

Example

Settings

On This Page

`Protected`_items