@tspro/ts-utils-lib
Preparing search index...
UniMap
Class UniMap<KEY, VALUE>
A Map implementation mapping a single key to a value.
Type Parameters
KEY
VALUE
Hierarchy (
View Summary
)
BaseContainer
UniMap
Implements
KVComponent
<
[
KEY
]
,
VALUE
>
Index
Constructors
constructor
Accessors
size
Methods
[iterator]
clear
clone
delete
entries
entries
Array
every
filter
for
Each
get
get
Or
Create
get
Or
Default
has
is
Empty
keys
keys
Array
kv
Entries
kv
Keys
kv
Values
map
Entries
map
Values
merge
reduce
set
some
to
Map
to
String
values
values
Array
create
Deep
Constructors
constructor
new
UniMap
<
KEY
,
VALUE
>
()
:
UniMap
<
KEY
,
VALUE
>
Type Parameters
KEY
VALUE
Returns
UniMap
<
KEY
,
VALUE
>
new
UniMap
<
KEY
,
VALUE
>
(
equals
?:
EqualityFn
<
KEY
>
)
:
UniMap
<
KEY
,
VALUE
>
Type Parameters
KEY
VALUE
Parameters
Optional
equals
:
EqualityFn
<
KEY
>
Returns
UniMap
<
KEY
,
VALUE
>
new
UniMap
<
KEY
,
VALUE
>
(
list
:
UniMap
<
KEY
,
VALUE
>
|
Iterable
<
[
KEY
,
VALUE
]
,
any
,
any
>
,
equals
?:
EqualityFn
<
KEY
>
,
)
:
UniMap
<
KEY
,
VALUE
>
Type Parameters
KEY
VALUE
Parameters
list
:
UniMap
<
KEY
,
VALUE
>
|
Iterable
<
[
KEY
,
VALUE
]
,
any
,
any
>
Optional
equals
:
EqualityFn
<
KEY
>
Returns
UniMap
<
KEY
,
VALUE
>
Accessors
size
get
size
()
:
number
Returns
number
Methods
[iterator]
"[iterator]"
()
:
IterableIterator
<
[
KEY
,
VALUE
]
>
Returns
IterableIterator
<
[
KEY
,
VALUE
]
>
clear
clear
()
:
void
Returns
void
clone
clone
()
:
UniMap
<
KEY
,
VALUE
>
Returns
UniMap
<
KEY
,
VALUE
>
delete
delete
(
key
:
KEY
)
:
boolean
Parameters
key
:
KEY
Returns
boolean
entries
entries
()
:
IterableIterator
<
[
KEY
,
VALUE
]
>
Returns
IterableIterator
<
[
KEY
,
VALUE
]
>
entries
Array
entriesArray
()
:
[
KEY
,
VALUE
]
[]
Returns
[
KEY
,
VALUE
]
[]
every
every
(
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
boolean
)
:
boolean
Parameters
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
boolean
Returns
boolean
filter
filter
<
S
>
(
predicate
:
(
value
:
VALUE
,
key
:
KEY
,
array
:
UniMap
<
KEY
,
VALUE
>
,
)
=>
value
is
S
,
)
:
UniMap
<
KEY
,
S
>
Type Parameters
S
Parameters
predicate
:
(
value
:
VALUE
,
key
:
KEY
,
array
:
UniMap
<
KEY
,
VALUE
>
)
=>
value
is
S
Returns
UniMap
<
KEY
,
S
>
filter
(
predicate
:
(
value
:
VALUE
,
key
:
KEY
,
array
:
UniMap
<
KEY
,
VALUE
>
,
)
=>
unknown
,
)
:
UniMap
<
KEY
,
VALUE
>
Parameters
predicate
:
(
value
:
VALUE
,
key
:
KEY
,
array
:
UniMap
<
KEY
,
VALUE
>
)
=>
unknown
Returns
UniMap
<
KEY
,
VALUE
>
for
Each
forEach
(
callbackfn
:
(
value
:
VALUE
,
key
:
KEY
,
map1
:
UniMap
<
KEY
,
VALUE
>
)
=>
void
,
thisArg
?:
any
,
)
:
void
Parameters
callbackfn
:
(
value
:
VALUE
,
key
:
KEY
,
map1
:
UniMap
<
KEY
,
VALUE
>
)
=>
void
Optional
thisArg
:
any
Returns
void
get
get
(
key
:
KEY
)
:
VALUE
|
undefined
Parameters
key
:
KEY
Returns
VALUE
|
undefined
get
Or
Create
getOrCreate
(
key
:
KEY
,
value
:
VALUE
)
:
VALUE
Parameters
key
:
KEY
value
:
VALUE
Returns
VALUE
getOrCreate
(
key
:
KEY
,
creator
:
()
=>
VALUE
)
:
VALUE
Parameters
key
:
KEY
creator
:
()
=>
VALUE
Returns
VALUE
get
Or
Default
getOrDefault
(
key
:
KEY
,
defaultValue
:
VALUE
)
:
VALUE
Parameters
key
:
KEY
defaultValue
:
VALUE
Returns
VALUE
has
has
(
key
:
KEY
)
:
boolean
Parameters
key
:
KEY
Returns
boolean
is
Empty
isEmpty
()
:
boolean
Returns
boolean
keys
keys
()
:
IterableIterator
<
KEY
>
Returns
IterableIterator
<
KEY
>
keys
Array
keysArray
()
:
KEY
[]
Returns
KEY
[]
kv
Entries
kvEntries
()
:
IterableIterator
<
[
[
KEY
]
,
VALUE
]
>
Returns
IterableIterator
<
[
[
KEY
]
,
VALUE
]
>
kv
Keys
kvKeys
()
:
IterableIterator
<
[
KEY
]
>
Returns
IterableIterator
<
[
KEY
]
>
kv
Values
kvValues
()
:
IterableIterator
<
VALUE
>
Returns
IterableIterator
<
VALUE
>
map
Entries
mapEntries
<
R
>
(
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
R
)
:
R
[]
Type Parameters
R
Parameters
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
R
Returns
R
[]
map
Values
mapValues
<
R
=
VALUE
>
(
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
R
)
:
UniMap
<
KEY
,
R
>
Type Parameters
R
=
VALUE
Parameters
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
R
Returns
UniMap
<
KEY
,
R
>
merge
merge
(
other
:
UniMap
<
KEY
,
VALUE
>
,
conflictResolver
?:
(
oldValue
:
VALUE
,
newValue
:
VALUE
,
key
:
KEY
)
=>
VALUE
,
)
:
this
Parameters
other
:
UniMap
<
KEY
,
VALUE
>
Optional
conflictResolver
:
(
oldValue
:
VALUE
,
newValue
:
VALUE
,
key
:
KEY
)
=>
VALUE
Returns
this
reduce
reduce
(
fn
:
(
acc
:
VALUE
,
value
:
VALUE
,
key
:
KEY
)
=>
VALUE
)
:
VALUE
Parameters
fn
:
(
acc
:
VALUE
,
value
:
VALUE
,
key
:
KEY
)
=>
VALUE
Returns
VALUE
reduce
<
R
>
(
fn
:
(
acc
:
R
,
value
:
VALUE
,
key
:
KEY
)
=>
R
,
init
:
R
)
:
R
Type Parameters
R
Parameters
fn
:
(
acc
:
R
,
value
:
VALUE
,
key
:
KEY
)
=>
R
init
:
R
Returns
R
set
set
(
key
:
KEY
,
value
:
VALUE
)
:
VALUE
Parameters
key
:
KEY
value
:
VALUE
Returns
VALUE
some
some
(
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
boolean
)
:
boolean
Parameters
fn
:
(
value
:
VALUE
,
key
:
KEY
)
=>
boolean
Returns
boolean
to
Map
toMap
()
:
Map
<
KEY
,
VALUE
>
Returns
Map
<
KEY
,
VALUE
>
to
String
toString
()
:
string
Returns
string
values
values
()
:
IterableIterator
<
VALUE
>
Returns
IterableIterator
<
VALUE
>
values
Array
valuesArray
()
:
VALUE
[]
Returns
VALUE
[]
Static
create
Deep
createDeep
<
KEY1
,
VALUE
>
()
:
UniMap
<
KEY1
,
VALUE
>
Type Parameters
KEY1
VALUE
Returns
UniMap
<
KEY1
,
VALUE
>
createDeep
<
KEY1
,
VALUE
>
(
set
:
UniMap
<
KEY1
,
VALUE
>
)
:
UniMap
<
KEY1
,
VALUE
>
Type Parameters
KEY1
VALUE
Parameters
set
:
UniMap
<
KEY1
,
VALUE
>
Returns
UniMap
<
KEY1
,
VALUE
>
createDeep
<
KEY1
,
VALUE
>
(
entries
:
Iterable
<
[
KEY1
,
VALUE
]
>
)
:
UniMap
<
KEY1
,
VALUE
>
Type Parameters
KEY1
VALUE
Parameters
entries
:
Iterable
<
[
KEY1
,
VALUE
]
>
Returns
UniMap
<
KEY1
,
VALUE
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Accessors
size
Methods
[iterator]
clear
clone
delete
entries
entries
Array
every
filter
for
Each
get
get
Or
Create
get
Or
Default
has
is
Empty
keys
keys
Array
kv
Entries
kv
Keys
kv
Values
map
Entries
map
Values
merge
reduce
set
some
to
Map
to
String
values
values
Array
create
Deep
@tspro/ts-utils-lib
Loading...
A Map implementation mapping a single key to a value.