LoroTree toJSON uses `meta` key where `data` would make more sense

Aperta
#891 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
rust, typescript
Ambito
api

Direzione di ricerca

Inizia individuando l'implementazione di toJSON di LoroTree e tutti i test di serializzazione. Confronta l'API node.data con il campo JSON attuale, quindi aggiorna l'output in modo coerente ed esegui i test pertinenti per confermare che toJSON utilizzi data.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

When working with LoroTree, the API uses node.data to access the node's LoroMap, but toJSON() outputs this as meta:

Example

import { LoroDoc } from "loro-crdt"

const doc = new LoroDoc()
const tree = doc.getTree("tree")

// Create a node
const node = tree.createNode()

// The API uses `.data` to access the node's LoroMap
node.data.set("name", "root")
node.data.set("value", 42)

console.log("API uses .data:", node.data.toJSON())
// Output: { name: "root", value: 42 }

// But toJSON() outputs it as `meta`
console.log("toJSON uses meta:", JSON.stringify(tree.toJSON(), null, 2))

Output:

[
  {
    parent: null,
    index: 0,
    meta: { name: 'root', value: 42 }, <-- "meta" instead of "data"
    id: '0@3781444021239823132',
    fractional_index: '80',
    children: []
  }
]

I think it would be more consistent if the toJSON() output also used data as the key here.

Lingua principale
Rust
Stelle
6.3k
Fork
205
Merge medio
3g 18h
PR unite (30g)
45

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di loro-dev/loro

Tutte le issue di loro-dev/loro

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.