Class Lists

Hierarchy

Lists

Index

Constructors

constructor

new Lists(): Lists

Returns Lists

Methods

addItemAtIndex

addItemAtIndex<T>(inputs: AddItemAtIndexDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20091
Add item to the list

group

add

shortname

item at index

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemAtIndexDto<T>
  
  a list, item and an index
Returns T[]

list with added item

addItemAtIndexes

addItemAtIndexes<T>(inputs: AddItemAtIndexesDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20100
Adds item to the list of provided indexes

group

add

shortname

item at indexes

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemAtIndexesDto<T>
  
  a list, item and an indexes
Returns T[]

list with added item

addItemFirstLast

addItemFirstLast<T>(inputs: AddItemFirstLastDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20136
Add item to the beginning or the end of the list

group

add

shortname

item at first or last

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemFirstLastDto<T>
  
  a list, item and an option for first or last position
Returns T[]

list with added item

addItemsAtIndexes

addItemsAtIndexes<T>(inputs: AddItemsAtIndexesDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20109
Adds items to the list of provided indexes matching 1:1, first item will go to first index provided, etc.

group

add

shortname

items at indexes

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemsAtIndexesDto<T>
  
  a list, items and an indexes
Returns T[]

list with added items

createEmptyList

createEmptyList(): []

- Defined in bitbybit-docs.d.ts:20144
Creates an empty list

group

create

shortname

empty list

drawable

false

Returns []

an empty array list

flipLists

flipLists<T>(inputs: ListDto<T[]>): T[][]

- Defined in bitbybit-docs.d.ts:20055
Flip 2d lists - every nth element of each list will form a separate list

group

edit

shortname

flip lists

drawable

false

Type parameters
- T
Parameters
- inputs: ListDto<T[]>
  
  a list of lists to flip
Returns T[][]

item

getByPattern

getByPattern<T>(inputs: GetByPatternDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20019
Gets elements by pattern

group

get

shortname

by pattern

drawable

false

Type parameters
- T
Parameters
- inputs: GetByPatternDto<T>
  
  a list and index
Returns T[]

list with removed item

getItem

getItem<T>(inputs: ListItemDto<T>): T

- Defined in bitbybit-docs.d.ts:19992
Gets an item from the list by using a 0 based index

group

get

shortname

item by index

drawable

false

Type parameters
- T
Parameters
- inputs: ListItemDto<T>
  
  a list and an index
Returns T

item

getListDepth

getListDepth(inputs: ListDto<[]>): number

- Defined in bitbybit-docs.d.ts:20073
Get the depth of the list

group

get

shortname

max list depth

drawable

false

Parameters
- inputs: ListDto<[]>
  
  a list
Returns number

number of depth

getLongestListLength

getLongestListLength<T>(inputs: GetLongestListLength<T[]>): number

- Defined in bitbybit-docs.d.ts:20037
Gets the longest list length from the list of lists

group

get

shortname

longest list length

drawable

false

Type parameters
- T
Parameters
- inputs: GetLongestListLength<T[]>
  
  a list of lists
Returns number

number of max length

getNthItem

getNthItem<T>(inputs: GetNthItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20010
Gets nth item in the list

group

get

shortname

every n-th

drawable

false

Type parameters
- T
Parameters
- inputs: GetNthItemDto<T>
  
  a list and index
Returns T[]

list with removed item

getSubList

getSubList<T>(inputs: SubListDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20001
Gets a sub list between start and end indexes

group

get

shortname

sublist

drawable

false

Type parameters
- T
Parameters
- inputs: SubListDto<T>
  
  a list and start and end indexes
Returns T[]

sub list

groupNth

groupNth<T>(inputs: GroupListDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20064
Group in lists of n elements

group

edit

shortname

group elements

drawable

false

Type parameters
- T
Parameters
- inputs: GroupListDto<T>
  
  a list
Returns T[]

items grouped in lists of n elements

listLength

listLength<T>(inputs: ListDto<T>): number

- Defined in bitbybit-docs.d.ts:20082
Gets the length of the list

group

get

shortname

list length

drawable

false

Type parameters
- T
Parameters
- inputs: ListDto<T>
  
  a length list
Returns number

a number

mergeElementsOfLists

mergeElementsOfLists<T>(inputs: MergeElementsOfLists<T[]>): T[]

- Defined in bitbybit-docs.d.ts:20028
Merge elements of lists on a given level and flatten output if needed

group

get

shortname

merge levels

drawable

false

Type parameters
- T
Parameters
- inputs: MergeElementsOfLists<T[]>
  
  lists, level and flatten data
Returns T[]

list with merged lists and flattened lists

removeItemAtIndex

removeItemAtIndex<T>(inputs: RemoveItemAtIndexDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20118
Remove item from the list

group

remove

shortname

item at index

drawable

false

Type parameters
- T
Parameters
- inputs: RemoveItemAtIndexDto<T>
  
  a list and index
Returns T[]

list with removed item

removeNthItem

removeNthItem<T>(inputs: RemoveNthItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20127
Remove item from the list

group

remove

shortname

every n-th

drawable

false

Type parameters
- T
Parameters
- inputs: RemoveNthItemDto<T>
  
  a list and index
Returns T[]

list with removed item

repeat

repeat<T>(inputs: MultiplyItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20153
Repeat the item and add it in the new list

group

create

shortname

repeat

drawable

false

Type parameters
- T
Parameters
- inputs: MultiplyItemDto<T>
  
  an item to multiply
Returns T[]

list

reverse

reverse<T>(inputs: ListDto<T>): T[]

- Defined in bitbybit-docs.d.ts:20046
Reverse the list

group

edit

shortname

reverse

drawable

false

Type parameters
- T
Parameters
- inputs: ListDto<T>
  
  a list and an index
Returns T[]

item

Generated using TypeDoc