BlockSuite API Documentation / @blocksuite/store / Y / Map
Class: Map<MapType>
Implements
Extends
AbstractType
<YMapEvent
<MapType
>>
Type parameters
• MapType
A shared Map implementation.
Implements
Iterable
<[string
,MapType
]>
Constructors
new Map(entries)
new Map<
MapType
>(entries
?):Map
<MapType
>
Parameters
• entries?: Iterable
<readonly [string
, any
]>
an optional iterable to initialize the YMap
Returns
Map
<MapType
>
Overrides
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:27
Properties
_dEH
_dEH:
EventHandler
<YEvent
<any
>[],Transaction
>
Deep event handlers
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:46
_eH
_eH:
EventHandler
<YMapEvent
<MapType
>,Transaction
>
Event handlers
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:41
_item
_item:
null
|Item
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:23
_length
_length:
number
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:36
_map
_map:
Map
<string
,Item
>
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:27
_prelimContent
private
_prelimContent:any
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:32
_searchMarker
_searchMarker:
null
|ArraySearchMarker
[]
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:50
_start
_start:
null
|Item
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:31
doc
doc:
null
|Doc
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:35
Accessors
_first
get
_first():null
|Item
The first non-deleted item
Returns
null
| Item
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:81
parent
get
parent():null
|AbstractType
<any
>
Returns
null
| AbstractType
<any
>
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:54
size
get
size():number
Returns the size of the YMap (count of key/value pairs)
Returns
number
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:65
Methods
[iterator]
()
[iterator]():
IterableIterator
<[string
,MapType
]>
Returns an Iterator of [key, value] pairs
Returns
IterableIterator
<[string
, MapType
]>
Implementation of
Iterable.[iterator]
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:128
_callObserver()
_callObserver(
transaction
,_parentSubs
):void
Creates YEvent and calls all type observers. Must be implemented by each type.
Parameters
• transaction: Transaction
• _parentSubs: Set
<null
| string
>
Keys changed on this type. null
if list was modified.
Returns
void
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:89
_copy()
_copy():
Map
<MapType
>
Returns
Map
<MapType
>
Overrides
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:47
_integrate()
_integrate(
y
,item
):void
Integrate this type into the Yjs instance.
- Save this struct in the os
- This type is sent to other client
- Observer functions are fired
Parameters
• y: Doc
The Yjs instance
• item: Item
Returns
void
Overrides
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:43
_write()
_write(
_encoder
):void
Parameters
• _encoder: UpdateEncoderV1
| UpdateEncoderV2
Returns
void
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:77
clear()
clear():
void
Removes all elements from this YMap.
Returns
void
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:122
clone()
clone():
Map
<MapType
>
Returns
Map
<MapType
>
Overrides
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:51
delete()
delete(
key
):void
Remove a specified element from this YMap.
Parameters
• key: string
The key of the element to remove.
Returns
void
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:95
entries()
entries():
IterableIterator
<[string
,MapType
]>
Returns an Iterator of [key, value] pairs
Returns
IterableIterator
<[string
, MapType
]>
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:83
forEach()
forEach(
f
):void
Executes a provided function on once on every key-value pair.
Parameters
• f
A function to execute on every element of this YArray.
Returns
void
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:89
get()
get(
key
):undefined
|MapType
Returns a specified element from this YMap.
Parameters
• key: string
Returns
undefined
| MapType
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:111
has()
has(
key
):boolean
Returns a boolean indicating whether the specified key exists or not.
Parameters
• key: string
The key to test.
Returns
boolean
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:118
keys()
keys():
IterableIterator
<string
>
Returns the keys for each element in the YMap Type.
Returns
IterableIterator
<string
>
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:71
observe()
observe(
f
):void
Observe all events that are created on this type.
Parameters
• f
Observer function
Returns
void
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:95
observeDeep()
observeDeep(
f
):void
Observe all events that are created by this type and its children.
Parameters
• f
Observer function
Returns
void
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:101
set()
set<
VAL
>(key
,value
):VAL
Adds or updates an element with a specified key and value.
Type parameters
• VAL
Parameters
• key: string
The key of the element to add to this YMap
• value: VAL
The value of the element to add
Returns
VAL
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:104
toJSON()
toJSON():
object
Transforms this Shared Type to a JSON object.
Returns
object
Overrides
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:57
unobserve()
unobserve(
f
):void
Unregister an observer function.
Parameters
• f
Observer function
Returns
void
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:107
unobserveDeep()
unobserveDeep(
f
):void
Unregister an observer function.
Parameters
• f
Observer function
Returns
void
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/AbstractType.d.ts:113
values()
values():
IterableIterator
<MapType
>
Returns the values for each element in the YMap Type.
Returns
IterableIterator
<MapType
>
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YMap.d.ts:77