Class DefaultArray<VALUE>

DefaultArray is an array list where every index is guaranteed to have a value. There are no undefineds unless that is part of the value type. When you create DefaultArray you give a default value. For example if you delete an index then that index is set to the default value.

Type Parameters

VALUE

Hierarchy (View Summary)

BaseContainer
- DefaultArray

Implements

KVComponent<[number], VALUE>

Index

Constructors

constructor

Accessors

length size

Constructors

constructor

new DefaultArray<VALUE>(defaultValue: VALUE): DefaultArray<VALUE>
Type Parameters
- VALUE
Parameters
- defaultValue: VALUE
Returns DefaultArray<VALUE>
Overrides BaseContainer.constructor
new DefaultArray<VALUE>(
length: number,
defaultValue: VALUE,
): DefaultArray<VALUE>
Type Parameters
- VALUE
Parameters
- length: number
- defaultValue: VALUE
Returns DefaultArray<VALUE>
Overrides BaseContainer.constructor
new DefaultArray<VALUE>(
values: Iterable<VALUE>,
defaultValue: VALUE,
): DefaultArray<VALUE>
Type Parameters
- VALUE
Parameters
- values: Iterable<VALUE>
- defaultValue: VALUE
Returns DefaultArray<VALUE>
Overrides BaseContainer.constructor

Accessors

length

get length(): number
Returns number

size

get size(): number
Returns number
Implementation of KVComponent.size

Methods

[iterator]

"[iterator]"(): IterableIterator<[number, VALUE]>
Returns IterableIterator<[number, VALUE]>

clear

clear(empty?: boolean): void
Parameters
- empty: boolean = false
Returns void
Implementation of KVComponent.clear

clone

clone(): DefaultArray<VALUE>
Returns DefaultArray<VALUE>

delete

delete(id: number): boolean
Parameters
- id: number
Returns boolean
Implementation of KVComponent.delete

entries

entries(): IterableIterator<[number, VALUE]>
Returns IterableIterator<[number, VALUE]>

entriesArray

entriesArray(): [number, VALUE][]
Returns [number, VALUE][]

equals

equals(other: DefaultArray<VALUE>): boolean
Parameters
- other: DefaultArray<VALUE>
Returns boolean
equals(other: DefaultArray<VALUE>, eq: (a: VALUE, b: VALUE) => boolean): boolean
Parameters
- other: DefaultArray<VALUE>
- eq: (a: VALUE, b: VALUE) => boolean
Returns boolean

every

every(fn: (value: VALUE, key1: number) => boolean): boolean
Parameters
- fn: (value: VALUE, key1: number) => boolean
Returns boolean

filter

filter<S>(
    predicate: (
        value: VALUE,
        id: number,
        array: DefaultArray<VALUE>,
    ) => value is S,
): DefaultArray<S>
Type Parameters
- S
Parameters
- predicate: (value: VALUE, id: number, array: DefaultArray<VALUE>) => value is S
Returns DefaultArray<S>
filter(
    predicate: (
        value: VALUE,
        id: number,
        array: DefaultArray<VALUE>,
    ) => unknown,
): DefaultArray<VALUE>
Parameters
- predicate: (value: VALUE, id: number, array: DefaultArray<VALUE>) => unknown
Returns DefaultArray<VALUE>

forEach

forEach(
callbackfn: (value: VALUE, id: number, arr: DefaultArray<VALUE>) => void,
thisArg?: any,
): void
Parameters
- callbackfn: (value: VALUE, id: number, arr: DefaultArray<VALUE>) => void
- OptionalthisArg: any
Returns void

get

get(id: number): VALUE
Parameters
- id: number
Returns VALUE
Implementation of KVComponent.get

getOrCreate

getOrCreate(id: number, value: VALUE): VALUE
Parameters
- id: number
- value: VALUE
Returns VALUE
Implementation of KVComponent.getOrCreate
getOrCreate(id: number, creator: () => VALUE): VALUE
Parameters
- id: number
- creator: () => VALUE
Returns VALUE
Implementation of KVComponent.getOrCreate

getOrDefault

getOrDefault(id: number, defaultValue: VALUE): VALUE
Parameters
- id: number
- defaultValue: VALUE
Returns VALUE
Implementation of KVComponent.getOrDefault

has

has(id: number): boolean
Internal
- This method exists only for interface KVComponent compatibility.
Parameters
- id: number
Returns boolean
Implementation of KVComponent.has

indices

indices(): IterableIterator<number>
Returns IterableIterator<number>

indicesArray

indicesArray(): number[]
Returns number[]

isDefault

isDefault(id: number): boolean
Parameters
- id: number
Returns boolean

isEmpty

isEmpty(): boolean
Returns boolean
Implementation of KVComponent.isEmpty

isSet

isSet(id: number): boolean
Parameters
- id: number
Returns boolean

kvEntries

kvEntries(): IterableIterator<[[number], VALUE]>
Returns IterableIterator<[[number], VALUE]>
Implementation of KVComponent.kvEntries

kvKeys

kvKeys(): IterableIterator<[number]>
Returns IterableIterator<[number]>
Implementation of KVComponent.kvKeys

kvValues

kvValues(): IterableIterator<VALUE>
Returns IterableIterator<VALUE>
Implementation of KVComponent.kvValues

map

map<R = VALUE>(
fn: (value: VALUE, key1: number) => R,
defaultValue: R,
): DefaultArray<R>
Type Parameters
- R = VALUE
Parameters
- fn: (value: VALUE, key1: number) => R
- defaultValue: R
Returns DefaultArray<R>

mapToArray

mapToArray<R>(fn: (value: VALUE, key1: number) => R): R[]
Type Parameters
- R
Parameters
- fn: (value: VALUE, key1: number) => R
Returns R[]

merge

merge(
other: DefaultArray<VALUE>,
conflictResolver?: (oldValue: VALUE, newValue: VALUE, id: number) => VALUE,
): this
Parameters
- other: DefaultArray<VALUE>
- OptionalconflictResolver: (oldValue: VALUE, newValue: VALUE, id: number) => VALUE
Returns this

reduce

reduce(fn: (acc: VALUE, value: VALUE, id: number) => VALUE): VALUE
Parameters
- fn: (acc: VALUE, value: VALUE, id: number) => VALUE
Returns VALUE
reduce<R>(fn: (acc: R, value: VALUE, id: number) => R, init: R): R
Type Parameters
- R
Parameters
- fn: (acc: R, value: VALUE, id: number) => R
- init: R
Returns R

set

set(id: number, value: VALUE): VALUE
Parameters
- id: number
- value: VALUE
Returns VALUE
Implementation of KVComponent.set

some

some(fn: (value: VALUE, id: number) => boolean): boolean
Parameters
- fn: (value: VALUE, id: number) => boolean
Returns boolean

toArray

toArray(): VALUE[]
Returns VALUE[]

toString

toString(): string
Returns string
Implementation of KVComponent.toString
Overrides BaseContainer.toString

values

values(): IterableIterator<VALUE>
Returns IterableIterator<VALUE>

valuesArray

valuesArray(): VALUE[]
Returns VALUE[]

Class DefaultArray<VALUE>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DefaultArray<VALUE>

Type Parameters

Parameters

Returns DefaultArray<VALUE>

Type Parameters

Parameters

Returns DefaultArray<VALUE>

Accessors

length

Returns number

size

Returns number

Methods

[iterator]

Returns IterableIterator<[number, VALUE]>

clear

Parameters

Returns void

clone

Returns DefaultArray<VALUE>

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[number, VALUE]>

entriesArray

Returns [number, VALUE][]

equals

Parameters

Returns boolean

Parameters

Returns boolean

every

Parameters

Returns boolean

filter

Type Parameters

Parameters

Returns DefaultArray<S>

Parameters

Returns DefaultArray<VALUE>

forEach

Parameters

Returns void

get

Parameters

Returns VALUE

getOrCreate

Parameters

Returns VALUE

Parameters

Returns VALUE

getOrDefault

Parameters

Returns VALUE

has

Parameters

Returns boolean

indices

Returns IterableIterator<number>

indicesArray

Returns number[]

isDefault

Parameters

Returns boolean

isEmpty

Returns boolean

isSet