Class List<Item>

Represents an immutable collection of objects that can be accessed by index. Provides methods to search, sort, and manipulate lists.

Type Parameters

Item = unknown

Hierarchy (view full)

ValueObject
- List

Implements

Iterable<Item>

Index

Constructors

constructor

new List<Item>(...items): List<Item>
Type Parameters
- Item = unknown
Parameters
- Rest...items: Item[]
Returns List<Item>
Overrides ValueObject.constructor
- Defined in collections/src/list.ts:13
new List<Item>(items?): List<Item>
Type Parameters
- Item = unknown
Parameters
- Optionalitems: Item[]
Returns List<Item>
Overrides ValueObject.constructor
- Defined in collections/src/list.ts:14
new List<Item>(items?): List<Item>
Type Parameters
- Item = unknown
Parameters
- Optionalitems: List<Item>
Returns List<Item>
Overrides ValueObject.constructor
- Defined in collections/src/list.ts:15

Accessors

count

get count(): number
Returns the number of items in the List.

Returns number
- Defined in collections/src/list.ts:30

first

get first(): undefined | Item
Returns the first item in the List.

Returns undefined | Item
- Defined in collections/src/list.ts:37

last

get last(): undefined | Item
Returns the last item in the List.

Returns undefined | Item
- Defined in collections/src/list.ts:44

Methods

[iterator]

[iterator](): Iterator<Item, any, undefined>
Returns a new iterator object that yields the Items for each element in the List in insertion order.

Returns Iterator<Item, any, undefined>
Implementation of Iterable.[iterator]
- Defined in collections/src/list.ts:195

clear

clear(): List<Item>
Removes an empty List with the same settings.

Returns List<Item>
- Defined in collections/src/list.ts:62

contains

contains(item): boolean
Determines whether the List contains an item.
Parameters
- item: Item
Returns boolean
- Defined in collections/src/list.ts:69

equals

equals(object): boolean
Determines if the Values are considered equal by comparing the types of both objects and then their attributes. Returns true if both the types and their attributes are equal.
Parameters
- object: ValueObject
Returns boolean
Inherited from ValueObject.equals
- Defined in core/dist/value-objects/value-object.d.ts:15

find

find(predicate): undefined | Item
Finds an item from the List using a predicate.
Parameters
- predicate: ((i: Item) => boolean)
  - - (i): boolean
    - Parameters
      i: Item
      Returns boolean
Returns undefined | Item
- Defined in collections/src/list.ts:76

forEach

forEach(callback): void
Performs the specified action for each item in the List.
Parameters
- callback: ((item: Item) => void)
  - - (item): void
    - Parameters
      item: Item
      Returns void
Returns void
- Defined in collections/src/list.ts:123

indexOf

indexOf(item): undefined | number
Returns the index of an item from the List.
Parameters
- item: Item
Returns undefined | number
- Defined in collections/src/list.ts:90

insert

insert(item): List<Item>
Returns a new List with the inserted item at the end.
Parameters
- item: Item
Returns List<Item>
- Defined in collections/src/list.ts:51

itemAt

itemAt(index): undefined | Item
Returns an item at a specific index from the List.
Parameters
- index: number
Returns undefined | Item
- Defined in collections/src/list.ts:83

map

map<Value>(mapper): List<Value>
Maps a List to a new List.
Type Parameters
- Value = Item
Parameters
- mapper: ((item: Item) => Value)
  - - (item): Value
    - Parameters
      item: Item
      Returns Value
Returns List<Value>
- Defined in collections/src/list.ts:130

notEquals

notEquals(object): boolean
Inverse of the equals method.
Parameters
- object: ValueObject
Returns boolean
Inherited from ValueObject.notEquals
- Defined in core/dist/value-objects/value-object.d.ts:19

remove

remove(item): List<Item>
Removes an item from the List.
Parameters
- item: Item
Returns List<Item>
- Defined in collections/src/list.ts:97

removeAt

removeAt(index): List<Item>
Removes an item at a certain index from the List.
Parameters
- index: number
Returns List<Item>
- Defined in collections/src/list.ts:112

shuffle

shuffle(): List<Item>
Returns a new shuffled List. Implemented using the Durstenfeld shuffle, an optimized version of Fisher-Yates shuffle.

Returns List<Item>
- Defined in collections/src/list.ts:140

sort

sort(compare?): List<Item>
Returns a new sorted List.
Parameters
- Optionalcompare: ((a: Item, b: Item) => number)
  - - (a, b): number
    - Parameters
      a: Item
      b: Item
      Returns number
Returns List<Item>
- Defined in collections/src/list.ts:154

unpack

unpack(): Item[]
Returns an Array from the List.

Returns Item[]
- Defined in collections/src/list.ts:165

`Static`from

from<Item, Value>(iterable, reducer): List<Item>
Returns a new List from an Array or another List.
Type Parameters
- Item
- Value
Parameters
- iterable: Iterable<Value>
- reducer: ((value: Value) => Item)
  - - (value): Item
    - Parameters
      value: Value
      Returns Item
Returns List<Item>
- Defined in collections/src/list.ts:172
from<Item>(iterable): List<Item>
Type Parameters
- Item = unknown
Parameters
- iterable: Iterable<Item>
Returns List<Item>
- Defined in collections/src/list.ts:177

`Static`isValueObject

isValueObject(obj): obj is ValueObject
Returns true if the argument is a ValueObject.
Parameters
- obj: unknown
Returns obj is ValueObject
Inherited from ValueObject.isValueObject
- Defined in core/dist/value-objects/value-object.d.ts:23

Class List<Item>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns List<Item>

Type Parameters

Parameters

Returns List<Item>

Type Parameters

Parameters

Returns List<Item>

Accessors

count

Returns number

first

Returns undefined | Item

last

Returns undefined | Item

Methods

[iterator]

Returns Iterator<Item, any, undefined>

clear

Returns List<Item>

contains

Parameters

Returns boolean

equals

Parameters

Returns boolean

find

Parameters

Parameters

Returns boolean

Returns undefined | Item

forEach

Parameters

Parameters

Returns void

Returns void

indexOf

Parameters

Returns undefined | number

insert

Parameters

Returns List<Item>

itemAt

Parameters

Returns undefined | Item

map

Type Parameters

Parameters

Parameters

Returns Value

Returns List<Value>

notEquals

Parameters

Returns boolean

remove

Parameters

Returns List<Item>

removeAt

Parameters

Returns List<Item>

shuffle

Returns List<Item>

sort

Parameters

Parameters

Returns number

Returns List<Item>

unpack

Returns Item[]

`Static`from

`Static`isValueObject