WriteableMapProxy

A data structure similar to a normal Map which accesses its data through API
commands to the Lucid app. This structure is iterable with for...of.

Extends

• MapProxy<KEY, VALUE>

Extended by

• ShapeDataProxy

Type parameters

Type parameter	Value
KEY	-
VALUE	-
WRITERETURN	-
WRITEVALUE	VALUE

---

Constructors

new WriteableMapProxy()

ts

new WriteableMapProxy<KEY, VALUE, WRITERETURN, WRITEVALUE>(
   getKeys, 
   getItem, 
setter): WriteableMapProxy<KEY, VALUE, WRITERETURN, WRITEVALUE>

Parameters

Parameter	Type
getKeys	() => KEY[]
getItem	(key) => VALUE
setter	(key, val, options?) => WRITERETURN

Returns

WriteableMapProxy<KEY, VALUE, WRITERETURN, WRITEVALUE>

Overrides

MapProxy.constructor

---

Accessors

size

ts

get size(): number

Returns

number

---

Methods

filter()

ts

filter(filter): VALUE[]

Parameters

Parameter	Type
filter	(item, key) => boolean

Returns

VALUE[]

Inherited from

MapProxy.filter

---

find()

ts

find(filter): undefined | VALUE

Parameters

Parameter	Type
filter	(item, key) => boolean

Returns

undefined | VALUE

Inherited from

MapProxy.find

---

first()

ts

first(): undefined | VALUE

Returns

undefined | VALUE

Inherited from

MapProxy.first

---

get()

ts

get(key): VALUE

Parameters

Parameter	Type
key	KEY

Returns

VALUE

Inherited from

MapProxy.get

---

keys()

ts

keys(): KEY[]

Returns

KEY[]

Inherited from

MapProxy.keys

---

map()

ts

map<T>(callback): T[]

Type parameters

Type parameter
T

Parameters

Parameter	Type
callback	(item, key) => T

Returns

T[]

Inherited from

MapProxy.map

---

set()

ts

set(
   key, 
   value, 
   options): WRITERETURN

Parameters

Parameter	Type
key	KEY
value	WRITEVALUE
options	SetterOptions

Returns

WRITERETURN

---

values()

ts

values(): Generator<VALUE & null | object, void, unknown>

Returns

Generator<VALUE & null | object, void, unknown>

Inherited from

MapProxy.values