Class LoroMap<T>

clear

• clear(): void

  Delete all key-value pairs in the map.

  Returns void

delete

• delete(key: string): void

  Parameters

  • key: string

  Returns void

• delete(key: string): void

  Remove the key from the map.

  Parameters

  • key: string

  Returns void

  Example

  import { LoroDoc } from "loro-crdt";
  
  const doc = new LoroDoc();
  const map = doc.getMap("map");
  map.set("foo", "bar");
  map.delete("foo");
  Copy

entries

• entries(): [string, Container | Value][]

  Get the entries of the map. If the value is a child container, the corresponding Container will be returned.

  Returns [string, Container | Value][]

  Example

  import { LoroDoc } from "loro-crdt";
  
  const doc = new LoroDoc();
  const map = doc.getMap("map");
  map.set("foo", "bar");
  map.set("baz", "bar");
  const entries = map.entries(); // [["foo", "bar"], ["baz", "bar"]]
  Copy

free

• free(): void

  Returns void

get

• get<Key extends string | number | symbol>(key: Key): T[Key]

  Get the value of the key. If the value is a child container, the corresponding Container will be returned.

  The object/value returned is a new js object/value each time because it need to cross the WASM boundary.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • key: Key

  Returns T[Key]

  Example

   import { LoroDoc } from "loro-crdt";
  
   const doc = new LoroDoc();
   const map = doc.getMap("map");
   map.set("foo", "bar");
   const bar = map.get("foo");
  Copy

getAttached

• getAttached(): undefined | LoroMap<Record<string, unknown>>

  Get the attached container associated with this.

  Returns an attached Container that equals to this or created by this, otherwise undefined.

  Returns undefined | LoroMap<Record<string, unknown>>

getLastEditor

• getLastEditor(key: string): undefined | `${number}`

  Get the peer id of the last editor on the given entry

  Parameters

  • key: string

  Returns undefined | `${number}`

getOrCreateContainer

• getOrCreateContainer<C extends Container>(key: string, child: C): C

  Get the value of the key. If the value is a child container, the corresponding Container will be returned.

  The object returned is a new js object each time because it need to cross

  Type Parameters

  • C extends Container

  Parameters

  • key: string
  • child: C

  Returns C

  Example

   import { LoroDoc } from "loro-crdt";
  
   const doc = new LoroDoc();
   const map = doc.getMap("map");
   map.set("foo", "bar");
   const bar = map.get("foo");
  Copy

getShallowValue

• getShallowValue(): Record<string, Value>

  Get the shallow value of the map.

  Unlike toJSON() which recursively resolves all containers to their values, getShallowValue() returns container IDs as strings for any nested containers.

  Returns Record<string, Value>

  Example

  import { LoroDoc, LoroText } from "loro-crdt";
  
  const doc = new LoroDoc();
  doc.setPeerId("1");
  const map = doc.getMap("map");
  map.set("key", "value");
  const subText = map.setContainer("text", new LoroText());
  subText.insert(0, "Hello");
  
  // Get shallow value - nested containers are represented by their IDs
  console.log(map.getShallowValue());
  // Output: { key: "value", text: "cid:1@1:Text" }
  
  // Get full value with nested containers resolved by `toJSON()`
  console.log(map.toJSON());
  // Output: { key: "value", text: "Hello" }
  Copy

isAttached

• isAttached(): boolean

  Whether the container is attached to a document.

  If it's detached, the operations on the container will not be persisted.

  Returns boolean

isDeleted

• isDeleted(): boolean

  Check if the container is deleted

  Returns boolean

keys

• keys(): any[]

  Get the keys of the map.

  Returns any[]

  Example

  import { LoroDoc } from "loro-crdt";
  
  const doc = new LoroDoc();
  const map = doc.getMap("map");
  map.set("foo", "bar");
  map.set("baz", "bar");
  const keys = map.keys(); // ["foo", "baz"]
  Copy

kind

• kind(): "Map"

  "Map"

  Returns "Map"

parent

• parent(): undefined | Container

  Get the parent container.

  • The parent container of the root tree is undefined.
  • The object returned is a new js object each time because it need to cross the WASM boundary.

  Returns undefined | Container

set

• set<Key extends string | number | symbol, V extends unknown>(
      key: Key,
      value: Exclude<V, Container>,
  ): void

  Set the key with the value.

  If the key already exists, its value will be updated. If the key doesn't exist, a new key-value pair will be created.

  Note: When calling map.set(key, value) on a LoroMap, if map.get(key) already returns value, the operation will be a no-op (no operation recorded) to avoid unnecessary updates.

  Type Parameters

  • Key extends string | number | symbol
  • V extends unknown

  Parameters

  • key: Key
  • value: Exclude<V, Container>

  Returns void

  Example

   import { LoroDoc } from "loro-crdt";
  
   const doc = new LoroDoc();
   const map = doc.getMap("map");
   map.set("foo", "bar");
   map.set("foo", "baz");
  Copy

setContainer

• setContainer<C extends Container, Key extends string | number | symbol>(
      key: Key,
      child: C,
  ): Exclude<T[Key], undefined | null> extends C
      ? C & Exclude<T[Key], undefined | null>
      : C

  Set the key with a container.

  Type Parameters

  • C extends Container
  • Key extends string | number | symbol

  Parameters

  • key: Key
  • child: C

  Returns Exclude<T[Key], undefined | null> extends C
      ? C & Exclude<T[Key], undefined | null>
      : C

  Example

   import { LoroDoc, LoroText, LoroList } from "loro-crdt";
  
   const doc = new LoroDoc();
   const map = doc.getMap("map");
   map.set("foo", "bar");
   const text = map.setContainer("text", new LoroText());
   const list = map.setContainer("list", new LoroList());
  Copy

subscribe

• subscribe(listener: Listener): Subscription

  Parameters

  • listener: Listener

  Returns Subscription

toJSON

• toJSON(): any

  Get the keys and the values. If the type of value is a child container, it will be resolved recursively.

  Returns any

  Example

  import { LoroDoc, LoroText } from "loro-crdt";
  
  const doc = new LoroDoc();
  const map = doc.getMap("map");
  map.set("foo", "bar");
  const text = map.setContainer("text", new LoroText());
  text.insert(0, "Hello");
  console.log(map.toJSON());  // {"foo": "bar", "text": "Hello"}
  Copy

values

• values(): any[]

  Get the values of the map. If the value is a child container, the corresponding Container will be returned.

  Returns any[]

  Example

  import { LoroDoc } from "loro-crdt";
  
  const doc = new LoroDoc();
  const map = doc.getMap("map");
  map.set("foo", "bar");
  map.set("baz", "bar");
  const values = map.values(); // ["bar", "bar"]
  Copy

constructor

• new LoroMap<T extends Record<string, unknown> = Record<string, unknown>>(): LoroMap<
      T,
  >

  Create a new detached LoroMap (not attached to any LoroDoc).

  The edits on a detached container will not be persisted. To attach the container to the document, please insert it into an attached container.

  Type Parameters

  • T extends Record<string, unknown> = Record<string, unknown>

  Returns LoroMap<T>

constructor

• new LoroMap(): LoroMap<T>

  Returns LoroMap<T>

Readonlyid

Readonlysize

import { LoroDoc } from "loro-crdt";

const doc = new LoroDoc();
const map = doc.getMap("map");
map.set("foo", "bar");
console.log(map.size);   // 1
Copy