Module Lists/listAccess

Index

Functions

Functions

getFirstInList

getFirstInList<V, K>(list: ReadList<V, K>, returnKey?: true): K
getFirstInList<V, K>(list: ReadList<V, K>, returnKey?: false | boolean): V

- Defined in src/Lists/listAccess.ts:186
Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- Optional returnKey: true
Returns K
- Defined in src/Lists/listAccess.ts:187
Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- Optional returnKey: false | boolean
Returns V

getLastInList

getLastInList<V, K>(list: ReadList<V, K>, returnKey?: true): K
getLastInList<V, K>(list: ReadList<V, K>, returnKey?: false | boolean): V

- Defined in src/Lists/listAccess.ts:200
Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- Optional returnKey: true
Returns K
- Defined in src/Lists/listAccess.ts:201
Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- Optional returnKey: false | boolean
Returns V

getListKeys

getListKeys<K>(list: ReadList<any, K>): K[]

- Defined in src/Lists/listAccess.ts:151
Returns the list of all keys of the given list element

Type parameters
- K
Parameters
- list: ReadList<any, K>
Returns K[]

getListSize

getListSize<V, K>(list: ReadList<V, K>): number

- Defined in src/Lists/listAccess.ts:218
Returns the length of the given list

Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
Returns number

getListType

getListType(element: any): ListType

- Defined in src/Lists/listAccess.ts:32
Returns an enum of ListType which defines the type of list that was given

Parameters
- element: any
Returns ListType

getListValue

getListValue<V, K>(list: ReadList<V, K>, key: K): undefined | V

- Defined in src/Lists/listAccess.ts:93
Returns the value of a given list at a given key

Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- key: K
Returns undefined | V

getNewList

getNewList<V, K>(type: ListType): List<V, K>

- Defined in src/Lists/listAccess.ts:77
Returns a new list object based on the given list type

Type parameters
- V
- K
Parameters
- type: ListType
Returns List<V, K>

getNthInList

getNthInList<V, K>(list: ReadList<V, K>, index: number, returnKey?: true): K
getNthInList<V, K>(list: ReadList<V, K>, index: number, returnKey?: false | boolean): V

- Defined in src/Lists/listAccess.ts:162
Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- index: number
- Optional returnKey: true
Returns K
- Defined in src/Lists/listAccess.ts:163
Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- index: number
- Optional returnKey: false | boolean
Returns V

listIntersect

listIntersect<V1, K1, V2, K2>(a: ReadList<V1, K1>, b: ReadList<V2, K2>): (V1 | V2)[]

- Defined in src/Lists/listAccess.ts:234
Returns the intersection of two lists

Type parameters
- V1 = any
- K1 = any
- V2 = any
- K2 = any
Parameters
- a: ReadList<V1, K1>
- b: ReadList<V2, K2>
Returns (V1 | V2)[]

listTypeSwitch

listTypeSwitch<V, K>(list: ReadList<V, K>, definition: ListTypeDefinition, type?: ListType): any

- Defined in src/Lists/listAccess.ts:56
Helper to call different actions based on the given list type

Type parameters
- V
- K
Parameters
- list: ReadList<V, K>
- definition: ListTypeDefinition
- Optional type: ListType
Returns any

setListValue

setListValue<V, K>(list: List<V, K>, value: V, key?: K): void

- Defined in src/Lists/listAccess.ts:123
Sets a value for a given key in the given list.

Type parameters
- V
- K
Parameters
- list: List<V, K>
- value: V
- Optional key: K
Returns void

Generated using TypeDoc